sphinx /

Filename Size Date modified Message
custom_fixers
doc
sphinx
tests
utils
268 B
Ignore files generated when building the test docs
1.9 KB
Added tag 1.2.2 for changeset 14b315a7d010
103 B
Configure Travis CI.
2.1 KB
Merges napoleon extension into mainline sphinx
45.7 KB
merge with stable
41.1 KB
changelog: split off older changes (pre-1.0) to a CHANGES.old file
9.8 KB
merge with stable
13.0 KB
Closes #1418: Private and special members are properly skipped on Python 3.3
620 B
Closes #1152: Fix pycode parsing errors of Python 3 code by including two grammar
1.6 KB
Ignore japanese search: it has long lines but breaking them would be ugly.
660 B
Update Sphinx URL to new sphinx-doc.org domain.
151 B
Dummy change.
574 B
Added improvements about i18n for themes "basic", "haiku" and "scrolls" that Sphinx built-in. Closes #1120
11.6 KB
Added a ez_setup to replace distribute_setup. ez_setup become defacto. Closes #1264
399 B
Add setup.py "upload" alias for automatic package signing.
7.3 KB
merge with stable
360 B
Update copyright year.
378 B
Update copyright year.
448 B
Update copyright year.
364 B
Update copyright year.
628 B
du10/du11 need mock dependency

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.

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.