The Sphinx documentation generator
Go to file
2019-03-30 14:50:37 +09:00
.circleci Use bionic (py36) on Circle CI 2019-03-09 17:57:20 +09:00
.github htps:// → https:// default project URL 2019-03-11 15:33:08 +01:00
doc Drop features and APIs deprecated in 1.8 2019-03-30 14:50:37 +09:00
sphinx Drop features and APIs deprecated in 1.8 2019-03-30 14:50:37 +09:00
tests Drop features and APIs deprecated in 1.8 2019-03-30 14:50:37 +09:00
utils Python-3-only clean ups discovered by pyupgrade 2019-03-19 01:09:48 +09:00
.appveyor.yml AppVeyor must be failed when pytest has any test failures. 2019-01-13 22:41:58 +09:00
.codecov.yml codecov: Disable status checks 2018-03-20 15:33:35 +00:00
.gitignore #5186 configure karma 2018-07-22 12:27:39 +02:00
.travis.yml Install graphiz on Travis 2019-03-19 01:19:37 +09:00
AUTHORS Append my name and contribution 2018-12-15 13:58:35 +09:00
babel.cfg Fix i18n: messages on sphinxmessages.sty_t are not extracted 2019-03-29 01:08:23 +09:00
bindep.txt Add bindep integration 2018-12-17 14:46:34 +00:00
CHANGES Drop features and APIs deprecated in 1.8 2019-03-30 14:50:37 +09:00
CHANGES.old changelog: split off older changes (pre-1.0) to a CHANGES.old file 2013-03-29 13:05:49 +01:00
CONTRIBUTING.rst Update deprecation policy by review. 2019-01-13 16:01:10 +09:00
EXAMPLES add QuTiP to projects using sphinx_rtd_theme 2019-02-26 00:07:31 +09:00
karma.conf.js #5186 configure karma 2018-07-22 12:27:39 +02:00
LICENSE A happy new year! 2019-01-02 16:00:30 +09:00
Makefile Fix Makefile (remove debug code...) 2018-11-28 02:02:53 +09:00
MANIFEST.in Remove 'test-reqs.txt' 2017-10-10 14:13:09 +01:00
package-lock.json #5258 update package-lock.json 2019-01-12 14:48:05 +01:00
package.json Update karma dependency for JS tests 2018-08-13 23:18:42 +02:00
README.rst Correct capitalization of PyPI 2018-09-16 13:41:09 -07:00
setup.cfg Remove redundant mypy config 'incremental' 2019-01-06 06:58:26 -08:00
setup.py Add long_description_content_type to package metadata 2019-03-10 18:57:50 +09:00
tox.ini Merge pull request #5832 from stephenfin/bindep-integration 2019-02-17 18:25:26 +09:00

========
 Sphinx
========

.. image:: https://img.shields.io/pypi/v/sphinx.svg
   :target: https://pypi.org/project/Sphinx/
   :alt: Package on PyPI

.. image:: https://readthedocs.org/projects/sphinx/badge/?version=master
   :target: http://www.sphinx-doc.org/
   :alt: Documentation Status

.. image:: https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master
   :target: https://travis-ci.org/sphinx-doc/sphinx
   :alt: Build Status (Travis CI)

.. image:: https://ci.appveyor.com/api/projects/status/github/sphinx-doc/sphinx?branch=master&svg=true
   :target: https://ci.appveyor.com/project/sphinxdoc/sphinx
   :alt: Build Status (AppVeyor)

.. image:: https://circleci.com/gh/sphinx-doc/sphinx.svg?style=shield
   :target: https://circleci.com/gh/sphinx-doc/sphinx
   :alt: Build Status (CircleCI)

.. image:: https://codecov.io/gh/sphinx-doc/sphinx/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/sphinx-doc/sphinx
   :alt: 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`__.

.. __: http://www.sphinx-doc.org/

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`__.

__ https://pypi.org/project/Sphinx/
__ http://www.sphinx-doc.org/en/master/devguide.html

Documentation
=============

Documentation is available from `sphinx-doc.org`__.

__ http://www.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`_.

.. _on GitHub: https://github.com/sphinx-doc/sphinx
.. _mailing list: https://groups.google.com/forum/#!forum/sphinx-users

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`__.

__ https://travis-ci.org/sphinx-doc/sphinx
__ https://ci.appveyor.com/project/sphinxdoc/sphinx
__ https://circleci.com/gh/sphinx-doc/sphinx
__ http://www.sphinx-doc.org/en/master/devguide.html

Contributing
============

Refer to `the contributors guide`__.

__ http://www.sphinx-doc.org/en/master/devguide.html

Release signatures
==================

Releases are signed with following keys:

* `498D6B9E <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x102C2C17498D6B9E>`_
* `5EBA0E07 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x1425F8CE5EBA0E07>`_