# 使用 Homebrew, apt 安装 sphinx-doc

查看 sphinx-doc 的安装路径、可执行文件、元数据以及面向 AI 代理工作流的安全说明。

## 安装

```sh
sudo av install brew:sphinx-doc
```

其他安装命令:

### macOS

- Homebrew (100%):

```sh
brew install sphinx-doc
```

  证据: local Homebrew formula metadata

### Linux

- Debian apt (92%):

```sh
sudo apt install sphinx-doc
```

  证据: Debian stable package indexes: sphinx-doc from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz

## 软件包事实

- **软件包键:** brew:sphinx-doc
- **软件包管理器:** Homebrew
- **软件包管理器页面:** <https://formulae.brew.sh/formula/sphinx-doc>
- **版本:** 9.1.0
- **来源摘要:** Tool to create intelligent and beautiful documentation
- **主页:** <https://www.sphinx-doc.org/>
- **仓库:** <https://github.com/sphinx-doc/sphinx>
- **上游文档:** <https://www.sphinx-doc.org/>
- **许可证:** BSD-2-Clause
- **源码归档:** <https://files.pythonhosted.org/packages/cd/bd/f08eb0f4eed5c83f1ba2a3bd18f7745a2b1525fad70660a1c00224ec468a/sphinx-9.1.0.tar.gz>
- **最后更新:** 2026-06-14T20:49:13-07:00
- **已生成:** 2026-08-04T22:13:35+00:00

## 可执行文件

- sphinx-apidoc (cli)
- sphinx-autogen (cli)
- sphinx-build (cli)
- sphinx-quickstart (cli)
- sphinx-apidoc (别名)
- sphinx-autogen (别名)
- sphinx-build (别名)
- sphinx-quickstart (别名)

## 依赖

- certifi
- python@3.14

## 安装行为

- post-install 钩子: 未定义
- Bottle: 可用 于 arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux

## 版本和新鲜度

- 页面生成时间: 2026-08-04
- 管理器版本: 9.1.0
- 管理器更新时间: 2026-06-14
- 本地数据: OK
- 上游仓库: https://www.sphinx-doc.org/
- 信息: Release/tag comparison is only available for GitHub repositories.
## 项目历史与用法

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.

### 项目历史

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.

### 采用历史

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.

### 使用方式

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.

### 为什么软件包爱好者会关心

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.

### 时间线

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

### 来源

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


## 安全说明

没有找到 sphinx-doc 的匹配本地密钥处理 manifest。软件包元数据仍在此发布，以便未来覆盖拥有稳定的软件包 URL。



## 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

- Unix: conf.py
## 源数据库详情

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** sphinx-doc
- **Aliases:** sphinx
- **Version Scheme:** 0
- **Revision:** 4
- **Head Version:** HEAD
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** head, stable

## 其他软件包管理器记录

- Debian apt - sphinx-doc - 8.1.3-5: normalized package name match | Debian stable package indexes: sphinx-doc from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz | documentation generator for Python projects - documentation | https://www.sphinx-doc.org/
- Ubuntu apt - sphinx-doc - 7.2.6-6: normalized package name match | Ubuntu 24.04 LTS package indexes: sphinx-doc from https://archive.ubuntu.com/ubuntu/dists/noble/main/binary-amd64/Packages.gz | documentation generator for Python projects - documentation | https://www.sphinx-doc.org/


## 相关链接

- [Terminal utility packages](https://pkg.so/zh-hans/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://pkg.so/zh-hans/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [Developer build packages](https://pkg.so/zh-hans/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata.
- [Language runtime packages](https://pkg.so/zh-hans/language-runtime-packages/) - Matched language runtime, compiler, or interpreter metadata.
- [python@3.14](https://pkg.so/zh-hans/brew/python-3-14/) - Runtime dependency declared by Homebrew.
- [docutils](https://pkg.so/zh-hans/brew/docutils/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, python, restructuredtext.
- [mkdocs-material](https://pkg.so/zh-hans/brew/mkdocs-material/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, python, static-site-generator.
- [pelican](https://pkg.so/zh-hans/brew/pelican/) - Shares pkgdb curated category or tags: cli, developer-tools, python, restructuredtext, static-site-generator.
- [rst-lint](https://pkg.so/zh-hans/brew/rst-lint/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, python, restructuredtext.
- [asciidoc](https://pkg.so/zh-hans/brew/asciidoc/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, python.
- [mdbook](https://pkg.so/zh-hans/brew/mdbook/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, static-site-generator.
- [docmd](https://pkg.so/zh-hans/brew/docmd/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, static-site-generator.
- [xml2rfc](https://pkg.so/zh-hans/brew/xml2rfc/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, python.
- [doc8](https://pkg.so/zh-hans/brew/doc8/) - Both packages touch the same language runtime or ecosystem. Shared terms: cli, developer, developer-tools, documentation, python.

## Combined YAML source

View the package source record on GitHub. [combined/sphinx-doc.yml](https://github.com/mxcl/pkgdb/blob/main/combined/sphinx-doc.yml)


## 来源

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