Sphinx 9.1.0

Python documentation generator

Stars: 7674, Watchers: 7674, Forks: 2377, Open Issues: 1404

The sphinx-doc/sphinx repo was created 11 years ago and the last code push was 2 days ago.
The project is extremely popular with a mindblowing 7674 github stars!

How to Install sphinx

You can install sphinx using pip

pip install sphinx

or add it to a project with poetry

poetry add sphinx

Package Details

Author

None

License

None

Homepage

None

PyPi:

https://pypi.org/project/Sphinx/

Documentation:

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

GitHub Repo:

https://github.com/sphinx-doc/sphinx

Classifiers

• Documentation
• Documentation/Sphinx
• Education
• Internet/WWW/HTTP/Site Management
• Internet/WWW/HTTP/Site Management/Link Checking
• Printing
• Software Development
• Software Development/Documentation
• Text Editors/Documentation
• Text Processing
• Text Processing/General
• Text Processing/Indexing
• Text Processing/Markup
• Text Processing/Markup/HTML
• Text Processing/Markup/LaTeX
• Text Processing/Markup/Markdown
• Text Processing/Markup/XML
• Text Processing/Markup/reStructuredText
• Utilities

Related Packages

Errors

A list of common sphinx errors.

Code Examples

Here are some sphinx code examples and snippets.

GitHub Issues

The sphinx package has 1404 open issues on GitHub

• Prune the new node in _resolve_toctree instead of copying, to accelerate building
• sphinx-build is too slow in large projects
• Bump ruff from 0.14.9 to 0.14.14
• Add intersphinx_request_headers confval
• Fix incorrect assertion in test_get_ratio
• Extension error (sphinxcontrib.newsfeed)!
• Error generating latex from Markdown with empty table
• Using sphinx.ext.napoleon with sphinx.ext.autodoc raises RemovedInSphinx11Warning
• Add bearer authentication option for intersphinx
• Fix incorrect assertion in test_extract_messages_without_rawsource
• autosummary templates have too little context for class members: attributes vs properties, abstract methods, etc…
• :number-lines: 0 for includes does not work correctly with docutils 0.22
• Fix/9093 theme basic css import
• Default CSS manpage similar to pre or code
• Anchor not found false positive

See more issues on GitHub