Main repository for the Sphinx documentation builder
Python JavaScript TeX HTML CSS Common Lisp Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci circleci: Install packages ourselves Dec 29, 2017
.github Add a mention for sphinx-users group to ISSUE_TEMPLATE Feb 18, 2018
doc autodoc: add 'exclude-members' to user global options Aug 17, 2018
sphinx Merge pull request #5215 from LewisHaley/lewis/allow-setting-audodoc-… Aug 18, 2018
tests autodoc: add 'exclude-members' to user global options Aug 17, 2018
utils Merge branch '1.7' May 13, 2018
.appveyor.yml Remove trailing whitespace Aug 11, 2018
.codecov.yml codecov: Disable status checks Mar 20, 2018
.gitignore #5186 configure karma Jul 22, 2018
.travis.yml test: Run tests for python-nightly-builds on xenial Aug 4, 2018
AUTHORS #5190 add new co-maintainer Jul 22, 2018
CHANGES Update CHANGES for PR #5215 Aug 18, 2018
CHANGES.old changelog: split off older changes (pre-1.0) to a CHANGES.old file Mar 29, 2013
CONTRIBUTING.rst #5186 add contrib doc for JS tests Jul 22, 2018
EXAMPLES Add PyXLL to EXAMPLES Aug 17, 2018
LICENSE Merge branch '1.7' Mar 3, 2018
MANIFEST.in Remove 'test-reqs.txt' Oct 10, 2017
Makefile make: Default to Python 3 Jun 21, 2018
README.rst Specify version in README.rst readthedocs shield May 1, 2018
babel.cfg babel location has changed from edgewall to pocoo May 29, 2017
karma.conf.js #5186 configure karma Jul 22, 2018
package-lock.json Update karma dependency for JS tests Aug 13, 2018
package.json Update karma dependency for JS tests Aug 13, 2018
setup.cfg Merge branch '1.7' Jul 16, 2018
setup.py Update all pypi.python.org URLs to pypi.org Apr 19, 2018
tox.ini Do test with py37 Jul 28, 2018

README.rst

Sphinx

Package on PyPi Documentation Status Build Status (Travis CI) Build Status (AppVeyor) Build Status (CircleCI) Code Coverage Status (Codecov)

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created for the new Python documentation, and has excellent facilities for Python project documentation, but C/C++ is supported as well, and more languages are planned.

Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

Among its features are the following:

  • Output formats: HTML (including derivative formats such as HTML Help, Epub and Qt Help), plain text, manual pages and LaTeX or direct PDF output using rst2pdf
  • Extensive cross-references: semantic markup and automatic links for functions, classes, glossary terms and similar pieces of information
  • Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
  • Automatic indices: general index as well as a module index
  • Code handling: automatic highlighting using the Pygments highlighter
  • Flexible HTML output using the Jinja 2 templating engine
  • Various extensions are available, e.g. for automatic testing of snippets and inclusion of appropriately formatted docstrings
  • Setuptools integration

For more information, refer to the the documentation.

Installation

Sphinx is published on PyPI and can be installed from there:

pip install -U sphinx

We also publish beta releases:

pip install -U --pre sphinx

If you wish to install Sphinx for development purposes, refer to the contributors guide.

Documentation

Documentation is available from sphinx-doc.org.

Get in touch

  • Report bugs, suggest features or view the source code on GitHub.
  • For less well defined questions or ideas, use the mailing list.

Testing

Continuous testing is provided by Travis (for unit tests and style checks on Linux), AppVeyor (for unit tests on Windows), and CircleCI (for large processes like TeX compilation).

For information on running tests locally, refer to the contributors guide.

Contributing

Refer to the contributors guide.

Release signatures

Releases are signed with following keys: