sphinx-doc mit Homebrew, apt installieren

Projektlinks

• Homepage
• Repository

Befehle und Aliase

• sphinx-apidoc
• sphinx-autogen
• sphinx-build
• sphinx-quickstart

Projektgeschichte

Sphinx's own documentation carries copyright years beginning in 2007, and its changelog records early 0.1 releases in March 2008. The project is now maintained by the sphinx-doc organization, with Georg Brandl listed among former maintainers and many later contributors.

Adoptionsgeschichte

Sphinx spread through Python packaging and documentation workflows because it combined Docutils/reStructuredText, Pygments highlighting, Jinja templating, cross-references, generated indexes, and extension hooks. Its official site highlights use by Python, the Linux Kernel, and Project Jupyter, and its installation docs cover PyPI, conda, operating-system packages, Docker, and source installs.

Wie es verwendet wird

The normal workflow is to create a documentation source tree, keep project settings in conf.py, and run sphinx-build or related commands such as sphinx-quickstart, sphinx-apidoc, and sphinx-autogen. Package maintainers often add Sphinx as a docs dependency and build documentation during release, CI, or distro packaging.

Warum Paket-Nerds sich dafür interessieren

Sphinx matters to package nerds because it is both software and packaging infrastructure: it produces documentation for packages, ships as a Python package itself, and is widely repackaged by OS distributions. Its dependency graph, extension ecosystem, and reproducible-docs behavior frequently show up in distro builds, PyPI metadata, Read the Docs projects, and language-package documentation workflows.

Zeitleiste

• 2007: Sphinx documentation copyright period begins.
• 2008: Sphinx 0.1 release series appears in the official changelog and PyPI history.
• 2010: Sphinx 1.0 is released.
• 2025: Sphinx 9.1.0 is published with PyPI provenance pointing back to sphinx-doc/sphinx.

Related projects

• Docutils provides the reStructuredText parsing foundation.
• Pygments provides code highlighting.
• Jinja provides templating for generated output.
• Read the Docs is a major hosting workflow for Sphinx-built documentation.

Quellen

• https://github.com/sphinx-doc/sphinx
• https://pypi.org/project/Sphinx/
• https://www.sphinx-doc.org/en/master/
• https://www.sphinx-doc.org/en/master/changes/index.html
• https://www.sphinx-doc.org/en/master/usage/configuration.html
• https://www.sphinx-doc.org/en/master/usage/installation.html