Sphinx 8.1.2

Python documentation generator

Stars: 6480, Watchers: 6480, Forks: 2108, Open Issues: 1251

The sphinx-doc/sphinx repo was created 9 years ago and the last code push was 4 hours ago.
The project is extremely popular with a mindblowing 6480 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
• Internet/WWW/HTTP/Site Management
• Printing
• Software Development
• Software Development/Documentation
• Text Processing
• Text Processing/General
• Text Processing/Indexing
• Text Processing/Markup
• Text Processing/Markup/HTML
• Text Processing/Markup/LaTeX
• 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 1251 open issues on GitHub

• Index word starting with Umlaut
• Ignoring python files that are present inside a directory with an init.py file.
• don't display a 'replaceable hardcoded link' when it contains a slash
• Fix #10133: autodoc: Crashed when mocked module is used for type annotation
• Fix #10121: html: <div> tag for admonition is not closed w/ docutils-0.18
• Inconsistent rendering of return/yield value documentation in NumPy-style docstrings
• error while formatting arguments … can only concatenate str (not "qualname") to str
• Fix #10122: make.bat should check the installation before help
• Close #10125: extlinks: Improve suggestion message for a reference having title
• Rename field-lists.rst to newfield-lists.rst
• [WIP] intersphinx, deprecate old explicit inventory specification
• [WIP] intersphinx, allow an inventory to be a self ref
• Close #10112: extlinks: Disable hardcoded links detector by default
• extlinks warnings: Improve suggestions when reST references are involved
• type annotations are not inherited by children which have other type annotations

See more issues on GitHub