sphinx
sphinx copied to clipboard
sphinx-doc
The Sphinx documentation generator
**Is your feature request related to a problem? Please describe.** Pages that don't have any section seems to be hard to work with. Also, their HTML `` looks odd (in...
It would be nice if hovering over the right side of the header to a glossary entry would expose a link in the same way that Sphinx does for function...
### Describe the bug When manually adding `:obj:` or `:class:` to the docstring types, they are no longer formatted as italics. Somehow Sphinx is able to implicitly hyperlink some of...
**Is your feature request related to a problem? Please describe.** With such kind of input: ```rst .. code-block:: :class: red crucial 1+1 ``` the HTML output will contain ```html 1+1...
### Feature or Bugfix - Feature - Bugfix - Refactoring ### Purpose Currently, Intersphinx is performing lookups in inventories purely by string comparison. Unfortunately this does not work in general....
### Describe the bug I'm creating a code docu using the docstring included in the code. In the conf.py file the intersphinx extension is included with mapping dicts to numpy,...
### Describe the bug `sphinx-apidoc -M -o modules/pkg pkg` generates files that contain duplicate entries if `pkg.wrapper` is an cpython extension module (.so file). The generated rst file looks like...
### Describe the bug I don't see "Next" or "Previous" links allowing to navigate in an exhaustive way throughout our documentation at https://www.sphinx-doc.org/en/master/ ### How to Reproduce Visit https://www.sphinx-doc.org/en/master/ ###...
It would be useful to have an option that causes Sphinx to automatically create a TOC entry for every function, class, and method. (In the absence of this, tables of...
Hi, I have greatly appreciated the improvements in `code-block` and `literalinclude`. I think there is still a functionality that would be nice to add. I think that it should be...
