birkenfeld / sphinx (http://sphinx.pocoo.org/)

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects, written by Georg Brandl and licensed under the BSD license.

Clone this repository (size: 20.7 MB): HTTPS / SSH
$ hg clone http://bitbucket.org/birkenfeld/sphinx/
commit 505: 9086e80b8740
parent 504: 10e306324d0c
child 506: c215303fca33
Remove sphinx-web script. default0.4
georg.brandl
21 months ago

 NB: This is not the latest revision. For the latest view, go to tip.

View at rev
sphinx /
filename size last modified message
doc  
sphinx  
tests  
utils  
AUTHORS 336 B 2 years ago Armin deserves special mention.
CHANGES 13.4 KB 21 months ago Release preparation.
EXAMPLES 961 B 21 months ago Add "who uses it" page.
LICENSE 1.5 KB 2 years ago Add authors and license files.
Makefile 629 B 22 months ago Add a test suite skeleton, a first test for sphinx.config,…
README 444 B 2 years ago Add mkdir step to README.
TODO 400 B 21 months ago Add default_role configuration value.
ez_setup.py 8.3 KB 2 years ago Add setup.py, add quickstart script.
setup.cfg 82 B 2 years ago Add new README, adapt setup.py.
setup.py 3.1 KB 21 months ago Remove sphinx-web script.
sphinx-build.py 280 B 2 years ago More refactoring, this time allowing different file…
sphinx-quickstart.py 286 B 2 years ago Add setup.py, add quickstart script.

README

Installing

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/>.

Contributing

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