1. Benoît Bryon
  2. sphinx


sphinx / README.rst

The branch 'apidoc-symlinks' does not exist.

README for Sphinx


Use setup.py:

python setup.py build
sudo python setup.py install

Reading the docs

After installing:

cd doc
sphinx-build . _build/html

Then, direct your browser to _build/html/index.html.

Or read them online at <http://sphinx.pocoo.org/>.


To run the tests with the interpreter available as python, use:

make test

If you want to use a different interpreter, e.g. python3, use:

PYTHON=python3 make test


Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com.