README for Sphinx

Installing

Use setup.py:

python setup.py build
sudo python setup.py install

After installing:

cd doc
sphinx-build . _build/html

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

Or read them online at <http://sphinx-doc.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.

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
custom_fixers		custom_fixers
doc		doc
sphinx		sphinx
tests		tests
utils		utils
.hgignore		.hgignore
.hgtags		.hgtags
.travis.yml		.travis.yml
AUTHORS		AUTHORS
CHANGES		CHANGES
EXAMPLES		EXAMPLES
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
Makefile		Makefile
README.rst		README.rst
TODO		TODO
babel.cfg		babel.cfg
distribute_setup.py		distribute_setup.py
requirements.txt		requirements.txt
setup.cfg		setup.cfg
setup.py		setup.py
sphinx-apidoc.py		sphinx-apidoc.py
sphinx-autogen.py		sphinx-autogen.py
sphinx-build.py		sphinx-build.py
sphinx-quickstart.py		sphinx-quickstart.py
tddium.yml		tddium.yml
tox.ini		tox.ini