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¶
Type¶
standard
Dependencies¶
$(PYTHON)
$(PYTHON_TOOLCHAIN)
alabaster: Default theme for the Sphinx documentation system
docutils: Processing plaintext documentation into useful formats, such as HTML or LaTeX
imagesize: Getting image size from png/jpeg/jpeg2000/gif file
importlib_metadata: Library to access the metadata for a Python package
snowballstemmer: Stemmer algorithms for natural language processing in Python
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
Version Information¶
package-version.txt:
7.4.7
version_requirements.txt:
sphinx >=7.4.7, <9
Equivalent System Packages¶
$ sudo pacman -S python-sphinx
$ conda install sphinx\>=5.2
$ sudo apt-get install sphinx
$ sudo yum install python3-sphinx
$ sudo pkg install textproc/py-sphinx
$ sudo emerge dev-python/sphinx
$ brew install sphinx-doc
$ sudo port install py-sphinx
$ sudo zypper install python3\$\{PYTHON_MINOR\}-Sphinx
$ 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.