.. _spkg_sphinx:

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


Version Information
-------------------

package-version.txt::

    4.4.0

install-requires.txt::

    sphinx >=4.3, <4.5


Equivalent System Packages
--------------------------

conda:

.. CODE-BLOCK:: bash

    $ conda install sphinx


gentoo:

.. CODE-BLOCK:: bash

    $ sudo emerge dev-python/sphinx


homebrew:

.. CODE-BLOCK:: bash

    $ brew install sphinx-doc


macports:
install the following packages: py-sphinx

opensuse:

.. CODE-BLOCK:: bash

    $ sudo zypper install python3-Sphinx


void:

.. CODE-BLOCK:: bash

    $ 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 :trac:`29023`