# sphinx /

Filename Size Date modified Message
custom_fixers
doc
sphinx
tests
utils
268 B
1.4 KB
2.1 KB
58.2 KB
7.4 KB
11.4 KB
523 B
1.6 KB
691 B
151 B
91 B
15.4 KB
356 B
7.5 KB
360 B
378 B
353 B
364 B
533 B

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

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.