Main repository for the Sphinx documentation builder
Python JavaScript TeX HTML CSS Makefile
Latest commit e6cd347 Jan 15, 2017 @tk0miya tk0miya Merge branch 'stable'
Permalink
Failed to load latest commit information.
.github refs #3222: add PULL_REQUEST_TEMPLATE.md Dec 17, 2016
doc Merge branch 'stable' Jan 15, 2017
sphinx Merge branch 'stable' Jan 15, 2017
tests Merge branch 'stable' Jan 15, 2017
utils Merge branch 'stable' Jan 12, 2017
.gitignore Ignore .cache/ Jan 7, 2017
.travis.yml Test pypy first to optimize Travis Jan 8, 2017
AUTHORS fix mark-up in AUTHORS (funny effect of ``T.``) Oct 27, 2016
CHANGES Merge branch 'stable' Jan 15, 2017
CHANGES.old changelog: split off older changes (pre-1.0) to a CHANGES.old file Mar 29, 2013
CONTRIBUTING.rst Reducing README.rst to avoid duplicated information in CONTRIBUTING.rst. Dec 17, 2016
EXAMPLES add MoinMoin to EXAMPLES Nov 22, 2016
LICENSE Obligatory copyright update. Jan 14, 2016
MANIFEST.in Update MANIFEST.in Dec 24, 2016
Makefile Merge branch 'stable' Jan 15, 2017
README.rst move badge to top. and add another badge. Dec 17, 2016
babel.cfg Added improvements about i18n for themes "basic", "haiku" and "scroll… Mar 4, 2013
mypy.ini Prepare to type-check using mypy Nov 16, 2016
setup.cfg Merge branch 'stable' into 3256_update_release_script Jan 13, 2017
setup.py Merge branch 'stable' Jan 7, 2017
sphinx-apidoc.py Obligatory copyright update. Jan 14, 2016
sphinx-autogen.py Obligatory copyright update. Jan 14, 2016
sphinx-build.py Obligatory copyright update. Jan 14, 2016
sphinx-quickstart.py Obligatory copyright update. Jan 14, 2016
test-reqs.txt Merge branch 'stable' Jan 9, 2017
tox.ini Merge branch 'stable' Jan 7, 2017

README.rst

Documentation Status https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master

README for Sphinx

This is the Sphinx documentation generator, see http://www.sphinx-doc.org/.

Installing

Install from PyPI to use stable version:

pip install -U sphinx

Install from PyPI to use beta version:

pip install -U --pre sphinx

Install from newest dev version in stable branch:

pip install git+https://github.com/sphinx-doc/sphinx@stable

Install from newest dev version in master branch:

pip install git+https://github.com/sphinx-doc/sphinx

Install from cloned source:

pip install .

Install from cloned source as editable:

pip install -e .

Release signatures

Releases are signed with following keys:

Reading the docs

You can read them online at <http://www.sphinx-doc.org/>.

Or, after installing:

cd doc
make html

Then, direct your browser to _build/html/index.html.

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

Continuous testing runs on travis: https://travis-ci.org/sphinx-doc/sphinx

Contributing

See CONTRIBUTING.rst