sphinx-doc/sphinx
The Sphinx documentation generator
Build with Backblaze B2
SDKs, agent skills, IDE extensions, and reference pipelines from Backblaze Labs. All open source.
Loading star history...
Where it stands
Rank, growth pace and release cadence relative to everything GStars tracks.
2 releases in the last 90 days, the latest 21 days ago, with 426 contributors on GitHub.
Use Cases & Benefits
- Generates intelligent and beautiful documentation from reStructuredText sources.
- Offers extensive output formats and a rich extension ecosystem for flexible, automated documentation workflows.
- Use for creating hierarchical, cross-referenced API documentation for Python projects.
- Use for producing multi-format technical manuals including HTML, PDF, and EPUB from a single source.
- Use for integrating Jupyter notebook content and code highlighting into comprehensive developer guides.
Should you depend on it?
License terms, project hygiene and risks, from GitHub metadata and GStars' snapshots.
License
Other
GitHub could not identify this license; read the LICENSE file before depending on it.
Community files
- README: present
- Contributing guide: present
Watch-outs
- License not identified by GitHub; read the LICENSE file before depending on it.
General guidance from repository metadata, not legal advice. How we score
From the README
.. image:: https://img.shields.io/pypi/v/sphinx.svg :target: https://pypi.org/project/Sphinx/ :alt: Package on PyPI
.. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg :target: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml :alt: Build Status
.. image:: https://readthedocs.org/projects/sphinx/badge/?version=master :target: https://www.sphinx-doc.org/ :alt: Documentation Status
.. image:: https://img.shields.io/badge/License-BSD%202--Clause-blue.svg :target: https://opensource.org/licenses/BSD-2-Clause :alt: BSD 2 Clause
Sphinx makes it easy to create intelligent and beautiful documentation.
Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
For more information, refer to
the documentation_.The following command installs Sphinx from the
Python Package Index_. You will need a working installation of Python and pip.pip install -U sphinx
Daily snapshots
Stars gained per day, and how forks and open issues moved, from GStars' daily snapshots
Forks
2.6K+102
Open issues
1.4K-70
Compared with peers in Documentation
Fastest-growing repositories GStars tracks in this cohort for the week of Nov 8, by 7-day star growth
| Repository | Stars | +7d | Health | Last release |
|---|---|---|---|---|
| hexojs/hexo | 41.8K | — | 55 | 186 days ago |
| ScrapeGraphAI/Scrapegraph-ai | 32.4K | — | 64 | 26 days ago |
| squidfunk/mkdocs-material | 27.6K | — | 65 | 8 days ago |
| sphinx-doc/sphinx | 8.1K | — | 75 | 21 days ago |
| MrLesk/Backlog.md | 7.3K | — | 59 | 17 days ago |
| geekjourneyx/md2wechat-skill | 3.8K | — | 26 | 45 days ago |
| Category median | 27.6K | — | 59 | — |
Discover Repositories
Search across tracked repositories by name or description