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

Hernan Grecco

Commits by Hernan Grecco were pushed to hgrecco/sphinx

62326c2 - Implemented support for pluggable Scorer A small javascript snippet containing a few constants and optionally a function can be used to tweak the ordering of ...
Hernan Grecco

Commits by Hernan Grecco were pushed to hgrecco/sphinx

3a354b0 - Creates an index of the words present in the titles Words in the titles are indexed and stored in searchindex.js in a field named titleterms. ...
Hernan Grecco

Commits by Hernan Grecco were pushed to hgrecco/sphinx

65ee4d3 - Object scoring based on full or partial matching of the name If the search term is equal to the object's name, the score is increased ...
Hernan Grecco

Commits by Hernan Grecco were pushed to hgrecco/sphinx

856c951 - Change from category- to score- based result ordering Instead of splitting the results in 4 categories (regular, important, unimportantResults, objectResults), the results are now collected ...
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.