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

Dmitry Shachnev

Dmitry Shachnev pushed 27 commits to mitya57/sphinx

08c6160 - Use \usepackage[language]{babel} instead of just \usepackage{babel} when possible
9f9cce7 - Fix: Multiple references in the same line return the same link with i18n. Closes #1193
9477ea8 - add tests for "multiple cross references in the same line return the same link". refs #1090, #1193
5328f9e - Fix multiple cross references (term, ref, doc) in the same line return the same link with i18n. refs #1090, #1193
5c620a0 - change: now XMLBuilder.get_target_uri() return docname to keep reference information from document to another document. refs #1193
Dmitry Shachnev

Dmitry Shachnev pushed 19 commits to mitya57/sphinx

b1773a9 - SingleHtml builder now calls write_doc_serialized(). Closes #1162.
72dceb3 - Fix: Citation target missing cause AssertionError. Closes #1160
518e76e - add OpenCV for EXAMPLES
48a41f1 - Fix: Combination of 'globaltoc.html' and hidden toctree cause exception. Closes #1157
7391c56 - PEP8tify conf.py generated by sphinx-quickstart
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.