sphinx: Build Structured Documentation Sites
Summary
Sphinx turns reStructuredText source into structured documentation in formats such as HTML, PDF, EPUB, and plain text. It suits teams and developers who need cross-linked, navigable documentation that can grow with a project.
At a glance
- Language
- Python
- License
- NOASSERTION
- Stars
- 8.1k
- Forks
- 2.6k
- Added to OSRepos
- February 6, 2026
- Last analyzed
- October 3, 2026
Use at your own risk
OSRepos shares public repositories for knowledge and discovery only. Any installation, execution, configuration, or use of code from these repositories is the user's own responsibility. Always review the repository, source code, dependencies, licenses, and security implications before running or installing anything. OSRepos is not responsible for issues, damages, or losses resulting from third-party repositories.
Overview
Sphinx is a Python documentation generator for turning source documents into navigable documentation sites and other output formats. It helps developers organize larger collections of documentation, connect related pages and code references, and produce consistent output from maintained source files.
It is a good fit when documentation needs more structure and automation than a collection of standalone pages can provide. Its primary markup language is reStructuredText, and its extension ecosystem can support additional languages and workflows.
Key Features
- Builds HTML, PDF, plain text, EPUB, TeX, and manual-page output.
- Creates cross-references for code objects, glossary terms, and other documented items.
- Organizes documents into a hierarchy with links between related pages.
- Generates general and module indices.
- Highlights source code using Pygments.
- Supports customizable HTML output with Jinja templates.
- Offers extensions for additional documentation workflows and languages.
Use Cases
- Python developers documenting packages, APIs, and code objects with linked references.
- Maintainers building a multi-page project manual with a hierarchy and generated indices.
- Teams publishing the same documentation in web and downloadable formats.
- Documentation authors extending a Sphinx site for workflows such as Jupyter notebook documentation.
Project Facts
- Language: Python
- License: NOASSERTION
- Stars: 8.1k
- Forks: 2.6k
- Topics: docs, documentation, documentation-tool, markdown, python, restructuredtext, sphinx
- Archived: No
Getting Started
Install Sphinx with pip:
pip install -U sphinx
See the README and official documentation for setup and usage details.
Alternatives
- MkDocs: MkDocs builds documentation sites from Markdown, while Sphinx uses reStructuredText by default and supports additional output formats such as EPUB and PDF.
- lat.md: lat.md generates linked Markdown files to explain a codebase, rather than building a navigable documentation site from authored documentation.
Considerations
- The README identifies reStructuredText as the primary markup language, so teams using another format may need to check whether an extension or conversion step suits their workflow.
- Installation requires a working Python and pip setup.
- Repository metadata reports the license as
NOASSERTION, while the README displays a BSD 2-Clause license badge. Check the repository's license details before relying on either value.
Source repository
Open the original repository on GitHub.
22 counted GitHub visits
Related repositories
Similar repositories that may be relevant next.
web-design: A Claude Code SKILL for Spec-First Web Page Design
October 3, 2026
The web-design project is a Claude Code SKILL designed to streamline the creation of beautiful and consistent web pages. It emphasizes a 'spec first, code second' approach, ensuring design principles are established before development begins. This tool helps generate UI, visuals, motion, and responsiveness that are consistent across pages and easily editable.
OOMWOO: Build Your Own Open-Source, Hackable Robot Vacuum Cleaner
October 2, 2026
OOMWOO is an ambitious open-source project enabling users to build their own robot vacuum cleaner using Raspberry Pi, 3D printing, and ROS2. It emphasizes local operation, hackability, and integration with Home Assistant, providing a high-quality, customizable home appliance. This project aims to deliver a fully open hardware, software, and firmware solution for autonomous home cleaning.
Shepherd: Reversible Execution Traces for Programmable Meta-Agents
October 2, 2026
Shepherd is a Python runtime substrate designed for agent work requiring inspection, reversibility, and supervision. It records agent runs as durable, inspectable execution traces, enabling meta-agents to observe, fork, replay, and revert any operation. This framework couples agents and environments using a copy-on-write fork, offering significant performance benefits and robust permission enforcement.
Agent Anvil: CI-First Evaluation Harness for Tool-Using AI Agents
October 1, 2026
Agent Anvil is a robust, CI-first evaluation harness designed for AI agents that utilize tools. It meticulously runs scenario suites, captures detailed traces of agent behavior, and provides semantic grading to identify issues. The platform excels at clustering failures and suggesting concrete fixes for prompts, tools, and guardrails, ensuring agents behave safely and effectively.