sphinx: Python documentation generator

Description

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 to translate the new Python documentation, but has now been cleaned up in the hope that it will be useful to many other projects.

License

Modified BSD; see e.g. its egg-info file for other options

Upstream Contact

• Author: Georg Brandl

• Home Page: http://www.sphinx-doc.org

• see also http://pypi.python.org/pypi/Sphinx

Dependencies

• Jinja2 >= 2.3

• Pygments >= 2.0

• docutils < 0.18

• snowballstemmer >= 1.1

• babel >= 1.3

• setuptools / distribute

• Python

• GNU patch (shipped with Sage)

Type

standard

Dependencies

• $(PYTHON)

• $(PYTHON_TOOLCHAIN)

• docutils: Processing plaintext documentation into useful formats, such as HTML or LaTeX

• jinja2: General purpose template engine for Python

• pygments: Generic syntax highlighter

• snowballstemmer: Stemmer algorithms for natural language processing in Python

• imagesize: Parser for image file metadata

• babel: Internationalization utilities for Python

• alabaster: Default theme for the Sphinx documentation system

• requests: An HTTP library for Python

• sphinxcontrib_websupport: Sphinx API for Web apps

• sphinxcontrib_applehelp: Sphinx extension which outputs Apple help book

• sphinxcontrib_devhelp: Sphinx extension which outputs Devhelp documents

• sphinxcontrib_htmlhelp: Sphinx extension which outputs HTML help book

• sphinxcontrib_jsmath: Sphinx extension which renders display math in HTML via JavaScript

• sphinxcontrib_qthelp: Sphinx extension which outputs QtHelp documents

• sphinxcontrib_serializinghtml: Sphinx extension which outputs serialized HTML files

• packaging: Core utilities for Python packages

• importlib_metadata: Library to access the metadata for a Python package

Version Information

package-version.txt:

5.2.3

install-requires.txt:

sphinx >=5.2, <6

Equivalent System Packages

conda:

$ conda install  sphinx<6,>=5.2

gentoo:

$ sudo emerge dev-python/sphinx

homebrew:

$ brew install sphinx-doc

macports: install the following packages: py-sphinx

opensuse:

$ sudo zypper install python3-Sphinx

void:

$ sudo xbps-install  python3-Sphinx

See https://repology.org/project/python:sphinx/versions

However, these system packages will not be used for building Sage because using Python site-packages is not supported by the Sage distribution; see github issue #29023