| single |
========
Sphinx
========
:alt: Package on PyPI
:alt: Documentation Status
:alt: Build Status (AppVeyor)
:alt: Build Status (CircleCI)
:alt: Code Coverage Status (Codecov)
:alt: BSD 3 Clause
:alt: Open Source Helpers badge
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/internals/contributing.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
Please adhere to our `code of conduct`__.
__ http://www.sphinx-doc.org/en/master/code_of_conduct.html
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).
|