Automic VaultAutomic Vault

brew

Install sphinx-doc with Homebrew, apt

Tool to create intelligent and beautiful documentation. Version 9.1.0 via Homebrew; verified 2026-06-14.

install

Additional install commands

macOS

Homebrewverified · 100%
brew install sphinx-doc

local Homebrew formula metadata

Linux

Debian aptverified · 92%
sudo apt install sphinx-doc

Debian stable package indexes · sphinx-doc · source: deb.debian.org

overview

Package summary

Tool to create intelligent and beautiful documentation

Commands and aliases

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

history

Project history and usage

Sphinx is a Python documentation generator that turns reStructuredText or MyST Markdown projects into HTML, LaTeX/PDF, EPUB, manual pages, Texinfo, and other formats. It became one of the default tools of Python and open source documentation culture.

Project history

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.

Adoption history

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.

How it is used

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.

Why package nerds care

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.

Timeline

  • 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.

security posture

No protected-tool coverage found yet

No matching local secret-handling manifest was found for sphinx-doc. Nucleus package metadata is still published here so future coverage has a stable package URL.

Install behavior

  • No Homebrew post-install hook is recorded in formula metadata.
  • Homebrew bottle metadata is available for 6 platform targets.
  • Installs with 2 runtime dependencies.

Recommended review

Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.

local files

Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.

Configuration files

Config paths the tool may read or write during local use.

Unix
conf.py

executables

Installed executables

CommandKindExposureNote
sphinx-apidoccliglobal executable
sphinx-autogencliglobal executable
sphinx-buildcliglobal executable
sphinx-quickstartcliglobal executable

freshness

Version and freshness

These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.

page generated2026-07-08
manager version9.1.0
manager updated2026-06-14
local dataok
upstreamnot checked
latest detectednot detected

https://www.sphinx-doc.org/

install metadata

Package metadata

Package keybrew:sphinx-doc
Version9.1.0
Package managerHomebrew
Package manager pagehttps://formulae.brew.sh/formula/sphinx-doc
Homepagehttps://www.sphinx-doc.org/
Repositoryhttps://github.com/sphinx-doc/sphinx
Upstream docshttps://www.sphinx-doc.org/en/master
LicenseBSD-2-Clause
Source archivehttps://files.pythonhosted.org/packages/cd/bd/f08eb0f4eed5c83f1ba2a3bd18f7745a2b1525fad70660a1c00224ec468a/sphinx-9.1.0.tar.gz
Last updated2026-06-14T20:49:13-07:00
Pulseupdated
Dependenciescertifi, python@3.14
Bottleavailable (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux)
Homebrew post-installnot defined
Servicenone declared

registry facts

Source database details

Source DatabaseHomebrew formula API
Taphomebrew/core
Full Namesphinx-doc
Aliases
  • sphinx
Version Scheme0
Revision4
Head VersionHEAD
Bottle Stable Root URLhttps://ghcr.io/v2/homebrew/core
Deprecatedno
Disabledno
Keg Onlyno
URL Keys
  • head
  • stable

source database matches

Other package-manager records

Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.

Debian apt95%

sphinx-doc 8.1.3-5

documentation generator for Python projects - documentation

https://www.sphinx-doc.org/

sudo apt install sphinx-doc
  • Section: doc
  • Architecture: all
  • Source Package: sphinx
  • 5 dependencies
  • normalized package name match
  • Matched by: Sphinx Doc
Debian stable package indexes · deb.debian.org · Debian stable package indexes: sphinx-doc from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz
Ubuntu apt95%

sphinx-doc 7.2.6-6

documentation generator for Python projects - documentation

https://www.sphinx-doc.org/

sudo apt install sphinx-doc
  • Section: doc
  • Architecture: all
  • Source Package: sphinx
  • 5 dependencies
  • normalized package name match
  • Matched by: Sphinx Doc
Ubuntu 24.04 LTS package indexes · archive.ubuntu.com · Ubuntu 24.04 LTS package indexes: sphinx-doc from https://archive.ubuntu.com/ubuntu/dists/noble/main/binary-amd64/Packages.gz

source trail

Generated from repository data

This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.

Used sources

  • Geiger risk classifier
  • Nucleus package database
  • av.db category and tag curation
  • cross-ecosystem install command graph
  • curated configuration and credential file locations
  • curated package history
  • external package-manager database matches
  • package relationship graph
  • package version freshness
  • package-page enrichment