macOS
Homebrew已验证 · 100%
brew install sphinx-doclocal Homebrew formula metadata
安装
其他安装命令
Linux
Debian apt已验证 · 92%
sudo apt install sphinx-docDebian stable package indexes · sphinx-doc · 来源: deb.debian.org
概览
软件包摘要
Tool to create intelligent and beautiful documentation
历史
项目历史与用法
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.
来源
安全态势
尚未找到受保护工具覆盖
没有找到 sphinx-doc 的匹配本地密钥处理 manifest。Nucleus 软件包元数据仍在此发布，以便未来覆盖拥有稳定的软件包 URL。
安装行为
- formula 元数据中未记录 Homebrew post-install 钩子。
- Homebrew bottle 元数据适用于 6 个平台目标。
- 安装时包含 2 个运行时依赖。
建议审查
在无人值守的代理使用前，请检查该工具是否读取明文凭据、写入远程状态、发布制品或调用插件。
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
可执行文件
已安装的可执行文件
| 命令 | 类型 | 暴露范围 | 备注 |
|---|---|---|---|
sphinx-apidoc | cli | 全局可执行文件 | |
sphinx-autogen | cli | 全局可执行文件 | |
sphinx-build | cli | 全局可执行文件 | |
sphinx-quickstart | cli | 全局可执行文件 |
新鲜度
版本和新鲜度
这些信号区分页生成时间、软件包管理器活动和上游发布比较。只有存在证据 URL 和可比较版本时，才会提示版本落后。
页面生成时间2026-07-10
管理器版本9.1.0
管理器更新时间2026-06-14
本地数据OK
上游not checked
检测到的最新版本未检测到
- 信息Release/tag comparison is only available for GitHub repositories.https://www.sphinx-doc.org/none 置信度
安装元数据
软件包元数据
| 软件包键 | brew:sphinx-doc |
|---|---|
| 版本 | 9.1.0 |
| 软件包管理器 | Homebrew |
| 软件包管理器页面 | https://formulae.brew.sh/formula/sphinx-doc |
| 主页 | https://www.sphinx-doc.org/ |
| 仓库 | https://github.com/sphinx-doc/sphinx |
| 上游文档 | https://www.sphinx-doc.org/en/master |
| 许可证 | BSD-2-Clause |
| 源码归档 | https://files.pythonhosted.org/packages/cd/bd/f08eb0f4eed5c83f1ba2a3bd18f7745a2b1525fad70660a1c00224ec468a/sphinx-9.1.0.tar.gz |
| 最后更新 | 2026-06-14T20:49:13-07:00 |
| Pulse | updated |
| 依赖 | certifi, python@3.14 |
| Bottle | 可用 (于 arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux) |
| Homebrew post-install | 未定义 |
| 服务 | 未声明 |
注册表事实
源数据库详情
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | sphinx-doc |
| Aliases |
|
| 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 |
|
源数据库匹配
其他软件包管理器记录
匹配项来自外部软件包管理器索引，并与本地 Automic Vault 软件包链接分开显示。
Debian apt95%
sphinx-doc 8.1.3-5
documentation generator for Python projects - documentation
sudo apt install sphinx-doc- Section: doc
- Architecture: all
- Source Package: sphinx
- 5 依赖
- normalized package name match
- 匹配方式：Sphinx Doc
Ubuntu apt95%
sphinx-doc 7.2.6-6
documentation generator for Python projects - documentation
sudo apt install sphinx-doc- Section: doc
- Architecture: all
- Source Package: sphinx
- 5 依赖
- normalized package name match
- 匹配方式：Sphinx Doc
来源线索
由仓库数据生成
此页面由 av-web 从 scripts/generate-pkg-sqlite.py 生成的私有软件包 SQLite 工件提供。
Combined YAML source
View the package source record on GitHub.
使用的来源
- 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