Main repository for the Sphinx documentation builder http://sphinx-doc.org/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Adam Turner cd3f2e4350 Update typing ignores for mypy 0.990 2 weeks ago
.github Use Sphinx 5.3+ in bug report template 4 weeks ago
doc Avoid a cramped LaTeX table column in our own document 4 weeks ago
sphinx Update typing ignores for mypy 0.990 2 weeks ago
tests Run the ``pyupgrade`` tool 1 month ago
utils Run the ``pyupgrade`` tool 1 month ago
.codecov.yml Revert "Enable patch status check for Codecov" 3 years ago
.gitignore C++, add support for parameterized noexcept specifier in function declarations 3 years ago
.readthedocs.yml Update `.readthedocs.yml` configuration (#10874) 2 months ago
AUTHORS Properly support `of` in docstring type specifiers (#10738) 4 months ago
CHANGES Recommend ``sphinxcontrib.jquery`` in CHANGES 3 weeks ago
CHANGES.old changelog: split off older changes (pre-1.0) to a CHANGES.old file 10 years ago
CODE_OF_CONDUCT docs: Tweaks to code of conduct 3 years ago
CONTRIBUTING.rst Minor typo in the contributing info 2 years ago
EXAMPLES Merge branch '4.x' into 5.0.x 6 months ago
LICENSE Remove deprecated items for Sphinx 6.0 (#10471) 5 months ago
Makefile Use declarative metadata 2 months ago
README.rst Add GPG key for Adam Turner 4 months ago
babel.cfg doc: Upgraded babel.pocoo.org links to HTTPS 2 years ago
bindep.txt Update bindep.txt for LaTeX pict2e.sty optional dependency 4 months ago
karma.conf.js Split out `sphinx_highlight.js` 2 months ago
package-lock.json Merge branch '4.x' into 5.x 8 months ago
package.json Merge branch '4.x' 8 months ago
pyproject.toml Update typing ignores for mypy 0.990 2 weeks ago
setup.cfg Migrate configs for isort, mypy, and pytest into pyproject.toml (#10844) 2 months ago
tox.ini Merge Docutils master tests into the main workflow 1 month ago

README.rst

Sphinx

Package on PyPI

Build Status

Documentation Status

BSD 2 Clause

Sphinx makes it easy to create intelligent and beautiful documentation.

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.

Features

  • Output formats: HTML, PDF, plain text, EPUB, TeX, manual pages, and more
  • 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 highlighting: automatic highlighting using the Pygments highlighter
  • Templating: Flexible HTML output using the Jinja 2 templating engine
  • Extension ecosystem: Many extensions are available, for example for automatic function documentation or working with Jupyter notebooks.
  • Language Support: Python, C, C++, JavaScript, mathematics, and many other languages through extensions.

For more information, refer to the the documentation.

Installation

The following command installs Sphinx from the Python Package Index. You will need a working installation of Python and pip.

pip install -U sphinx

Contributing

We appreciate all contributions! Refer to the contributors guide for information.

Release signatures

Releases are signed with following keys: