Showing posts with label documentation. Show all posts
Showing posts with label documentation. Show all posts

Wednesday, May 20, 2009

Installing sphinx and building docs

To install Sphinx, execute this from within any directory.

sudo easy_install -U sphinx

To build the docs, change and then execute as follows.

$ cd abjad/documentation/doc_sphinx

Then:

$ make html

Sphinx runs for a while.

sphinx-build -b html -d _build/doctrees . _build/html
Making output directory...
Running Sphinx v0.6.1
loading pickled environment... not found
building [html]: targets for 460 source files that are out of date
updating environment: 460 added, 0 changed, 0 removed
reading sources...
[ 44%] chapters/api/tools/clonewp/by_leaf_counts_with_parentareading sources...
[ 44%] chapters/api/tools/clonewp/by_leaf_range_with_parentag

And then finishes.