Mixxx User Manual

This repository contains the sources for generating the Mixxx User Manual as found at http://mixxx.org/manual/latest/.

The user manual for Mixxx is written in reStructuredText format using the Sphinx documentation generator.

Sphinx and RST syntax guides:

• http://sphinx-doc.org/rest.html
• http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
• http://www.siafoo.net/help/reST
• http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html

Steps for use:

• Install Sphinx, the documentation generator
• Install Graphviz, a graph visualization software
• Download the latest Mixxx manual source
• Edit .rst files in source/
• Run make html
• Open the file build/html/index.html in your Web browser to view the results

Run make linkcheck in the terminal. Sphinx will validate all internal and external links in the document, and let you know if any links are malformed, or point to dead URLs.

Guidelines

Open the file build/html/manual_guidelines.html in your Web browser to view the
Guidelines for Mixxx Manual writers.

Editors with Restructured Text (reST) syntax highlighting

• Windows, Linux, Mac OSX : Sublime
• Linux: Kate or Retext
• Windows: Intype

Still not enough?

Even more resources: http://stackoverflow.com/questions/2746692/restructuredtext-tool-support