mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
The Sphinx documentation generator
| .circleci | ||
| .github | ||
| doc | ||
| sphinx | ||
| tests | ||
| utils | ||
| .codecov.yml | ||
| .gitignore | ||
| .readthedocs.yml | ||
| AUTHORS | ||
| babel.cfg | ||
| bindep.txt | ||
| CHANGES | ||
| CHANGES.old | ||
| CODE_OF_CONDUCT | ||
| CONTRIBUTING.rst | ||
| EXAMPLES | ||
| karma.conf.js | ||
| LICENSE | ||
| Makefile | ||
| MANIFEST.in | ||
| package-lock.json | ||
| package.json | ||
| README.rst | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
======== 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://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) .. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg :target: https://opensource.org/licenses/BSD-3-Clause :alt: BSD 3 Clause .. image:: https://codetriage.com/sphinx-doc/sphinx/badges/users.svg :target: https://codetriage.com/sphinx-doc/sphinx :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). 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/internals/contributing.html Contributing ============ Refer to `the contributors guide`__. __ http://www.sphinx-doc.org/en/master/internals/contributing.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>`_