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#

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#

Version Information#

package-version.txt:

5.2.3

install-requires.txt:

sphinx >=5.2, <8

Equivalent System Packages#

arch:

$ sudo pacman -S  python-sphinx

conda:

$ conda install  sphinx<8,>=5.2

Debian/Ubuntu:

$ sudo apt-get install  sphinx

Fedora/Redhat/CentOS:

$ sudo yum install  python-sphinx

freebsd:

$ sudo pkg install textproc/py-sphinx

gentoo:

$ sudo emerge dev-python/sphinx

homebrew:

$ brew install sphinx-doc

macports: install the following packages: py-sphinx

opensuse:

$ sudo zypper install python3${PYTHON_MINOR}-Sphinx

void:

$ sudo xbps-install  python3-Sphinx

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

If the system package is installed and if the (experimental) option –enable-system-site-packages is passed to ./configure, then ./configure will check if the system package can be used.