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

  • six >= 1.4

  • Jinja2 >= 2.3

  • Pygments >= 2.0

  • docutils >= 0.11

  • snowballstemmer >= 1.1

  • babel >= 1.3

  • setuptools / distribute

  • Python

  • GNU patch (shipped with Sage)

Special Update/Build Instructions

  • The script create_grammar_pickle.py creates the file Grammar2.7.pickle in site-packages/Sphinx-…/sphinx/pycode/. This helps to avoid race conditions when building the documentation in parallel.

Type

standard

Version Information

package-version.txt:

3.1.2.p0

install-requires.txt:

# gentoo uses 3.2.1
sphinx >=3, <3.3

Equivalent System Packages

conda:

$ conda install python:sphinx

macports: install the following packages: python:sphinx opensuse:

$ sudo zypper install python: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 https://trac.sagemath.org/ticket/29023