This repository contains the sources for the Mixxx User Manual as found at http://mixxx.org/manual/latest/.
The manual is written in reStructuredText format using the Sphinx documentation generator.
First Download the latest Mixxx manual source or clone the repository
$ git clone https://github.com/mixxxdj/manual.git
Next, install the dependencies using pip. From within the repository root
(type cd manual after typing the above command):
$ pip install -r requirements.txt
If you do not wish to use pip:
- Install Sphinx, the documentation generator. Note: Version 1.3.1 seems to have a bug with graphviz. We suggest using version 1.2.3 until this is resolved.
- Install Graphviz, graph visualization software (used to draw some diagrams)
If you'd like to build manual PDFs, you will need a functioning LaTeX installation.
- On Mac, install MacTeX.
- On Debian-based systems, install
texlive-fonts-recommendedandtexlive-latex-extra.
Once you have the repository cloned and dependencies installed you can edit and build the manual to see your changes.
- Edit .rst files in
source/ - Run
make htmlto build an HTML version of the manual - Open the file
build/html/index.htmlin 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.
The Mixxx manual is based on sound learning principles, and is supposed to be user-friendly & motivational. Please refer to the guidelines for style conventions:
- Run
make htmlto build an HTML version of the manual, then openbuild/html/manual_guidelines.htmlin your browser (recommended). - Alternatively, open https://github.com/mixxxdj/manual/blob/manual/source/manual_guidelines.rst for a quick overview. Github may not render all code correct.
- Clone the repository
git clone https://github.com/mixxxdj/manual.git - Perform changes
- Commit changes
git commit -m "Insert short summary of your changes here" - Push changes
git push - Submit a pull request
- Commit file edits through the GitHub web interface using the Fork and Edit button
- Submit a pull request
The Mixxx manual is translated using the Transifex web service for team translation.
If you did not install requirements with pip install -r requirements.txt above
then you must manually install the following dependencies:
-
sphinx-intl, a utility that makes it easy to translate and compile translations to Sphinx projects.
-
transifex-client. Transifex allows collaborative translation via a web interface. The Python-based command line client makes it easy to fetch and push translations.
Install transifex-client on Linux and Mac OS X
pip install transifex-clientInstall transifex-client on Windows
http://files.transifex.com/transifex-client/0.11b3/tx.exeYou will need to make a
.transifexrcin your home directory with your username and password to use the Transifex client. See transifex-configuration for more details.
These steps document how to maintain the translations of the Mixxx manual. Typically, unless you are a manual maintainer you do not need to perform these steps. However, it is appreciated if you update the source translations when making changes to the manual.
For every change to the manual source files (.rst) the source translation files
(.pot) must be re-generated. These are stored in source/locale/pot and contain
the text of every English phrase in the manual in a common format used for
translation.
Additionally, for every new source file added (i.e. new chapters or manaul
pages) the Transifex configuration file (stored in .tx/config) needs updating.
To do both of these, run:
fab i18n_update_source_translations
Commit the new source translations and Transifex configuration with:
git add source/translations/pot .tx
git commit -m "Update source translations and Transifex configuration."
After generating new source translation files and updating the Transifex configuration, you must push the new source files to Transifex to be translated.
To do this, run:
fab tx_push
To pull newly completed translation (.po) files from Transifex, run:
fab tx_pull
Commit the changes to the repository with:
git add source/translations
git commit -m "Pull latest translations from Transifex."
To compile the translations (.po) from Transifex into compiled translation (.mo) files, run:
fab i18n_build
We do not check .mo files into the repository, so make sure you do not add
them (they are ignored by our .gitignore).
Note: it's good practice to clean your build directory first:
fab clean
For example, to build an HTML manual for de-DE (Germany/Germany):
fab i18n_build html:language=de-DE
Unless an error occurred, your translated HTML manual is in the build/html
directory.
To build a PDF manual:
fab i18n_build pdf:language=de-DE
Your translated PDF manual is located at build/latex/Mixxx-Manual.pdf.
For more information on Translating with Sphinx, see Sphinx i18n.
- Fix and delete todos listed in
build/html/todolist.html - Fix and close issues listed in https://github.com/mixxxdj/manual/issues
- Temporarily disable the For documentation writers toctree from TOC in
/index.rst - Update the release and version tags in
/conf.py - Tag the repository with the version number, and create a new release.
- Run
fab htmlto produce html output ready for upload to http://mixxx.org/manual/latest/ - Check the output compiles correctly and does not produce any warnings
- Add translated html output for all available languages, see i18n
- Run
fab pdfto produce PDF output for distribution
- 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
Even more reStructuredText resources: http://stackoverflow.com/questions/2746692/restructuredtext-tool-support