Bitbucket is a code hosting site with unlimited public and private repositories. We're also free for small teams!

Close

README for Sphinx

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

Testing

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

Contributing

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

Recent activity

Andi Albrecht

Commits by Andi Albrecht were pushed to avalentino/sphinx

348224a - Set default background color in header for agogo theme. This allows to header to grow larger than the height of the background image.
Melissa Draper

Commits by Melissa Draper were pushed to avalentino/sphinx

1648861 - Added language names to the shorthandoff helper Docutils 0.8.1 reports full language names not codes
Melissa Draper

Commits by Melissa Draper were pushed to avalentino/sphinx

9fced0d - Added language names to the shorthandoff helper Docutils 0.8.1 reports full language names not codes
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.