Mixxx

lp:~mixxxdevelopers/mixxx/manual

Created by RJ Skerry-Ryan on 2011-03-15 and last modified on 2013-10-27

********************************
********************************
We moved to GitHub
https://github.com/mixxxdj/manual
********************************
********************************

Manual for lp:mixxx
Current focus of development

Contains the Sphinx source to generate the Mixxx user manual as found at
http://mixxx.org/manual/latest/

Editing syntax can be found here:
http://sphinx.pocoo.org/rest.html
http://www.siafoo.net/help/reST
http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html

Steps for use:
1) Install Sphinx ('python-sphinx' package in Debian/Ubuntu) and GNU make
2) Install Graphviz, needed to draw some diagrams
    ('graphviz' and 'libgraphviz4' package in Debian/Ubuntu, 'graphviz' on OSX macports,
    http://graphviz.org/Download_windows.php on Windows.
    There is no need to install 'python-graphviz')
3) Edit .rst files in source/
4) Run 'make html'
5) Open the file 'build/html/index.html' in your Web browser to view the results

Hint:
Run 'make linkcheck'
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 for Mixxx Manual writers are in /source/manual_guidelines.rst

Get this branch:: bzr branch lp:~mixxxdevelopers/mixxx/manual

Members of Mixxx Development Team can upload to this branch. Log in for directions.

Branch merges

No branches dependent on this one.

Related bugs

Bug #879084: Unify word choice within Mixxx	Low	Fix Released
Bug #999703: Manual doesn't explain how to create a custom keyboard mapping	Low	Fix Released
Bug #1108212: Library Path wrong in the manual (Windows)	Low	Fix Released

Link a bug report

Related blueprints

Branch information

Owner:: Mixxx Development Team

Project:: Mixxx

Status:: Development

Recent revisions

303. By jus on 2013-05-13: Merge from lp:~mixxxdevelopers/mixxx/manual-1.11.x
302. By jus on 2013-05-12: Merge from lp:~mixxxdevelopers/mixxx/manual-1.11.x
301. By RJ Skerry-Ryan on 2013-05-08: Wordsmithing, spelling corrections, grammar, etc.
300. By jus on 2013-05-03: 300! Add link to reStructuredText Markup Specification in manual_guidelines.rst
299. By jus on 2013-05-03: Formatting in appendix.rst
298. By jus on 2013-05-03: Formatting in advanced_topics.rst
297. By jus on 2013-05-03: Formatting in djing_with_mixxx.rst
296. By jus on 2013-05-03: Make tables pretty by changing to booktabs/APA style in mixxx.css_t
295. By jus on 2013-05-03: Make border style less prominent in mixxx.css_t.
294. By jus on 2013-05-03: Use the “figure” directives borders style in mixxx.css_t also for images inside tables

Branch metadata

Branch format:: Branch format 7

Repository format:: Bazaar repository format 2a (needs bzr 1.16 or later)

Stacked on:: lp:~mixxxdevelopers/mixxx/trunk

This branch contains Public information

Everyone can see this information.

Subscribers

Mixxx Development...