sphinx icon indicating copy to clipboard operation
sphinx copied to clipboard

The Sphinx documentation generator

Results 596 sphinx issues
Sort by recently updated
recently updated
newest added
trafficstars

fix a few more type errors.

This transfers here development from #6666 to continue it and merge with #6671. - [x] revamp initial work of @sephalon in #6666 for compatibility with current Sphinx LaTeX and to...

enhancement
latex

For inherited attributes qualname will not match the name of the actual obj that the attribute belongs to Subject: Autosummary don't filter attributes on qualname ### Feature or Bugfix -...

### Describe the bug I'm having trouble with sphinx and autosummary. Apparently, sphinx is unable to document inherited instance attributes. For some reason, the resulting error is an import error....

bug

**Describe the bug** Sphinx fails to import & document a module that is itself imported in an `__init__.py` file. I'm at a loss as to understand why; on the face...

bug
autosummary

**Describe the bug** Recursive `autosummary` produces broken documentation and emits a `WARNING: autosummary: stub file not found` message when a module contains a reference to itself. **To Reproduce** Assume a...

type:bug
extensions:autosummary

**Is your feature request related to a problem? Please describe.** In our current software package we use the really nice recursive feature of autosummary to automatically generate our API docs...

enhancement

doc/usage/installation.rst update and improve text on virtual environments

Restructured text has a [class directive](https://docutils.sourceforge.io/docs/ref/rst/directives.html#class) that lets you add a css class to an element. This won't work in Sphinx because it conflicts with the default domain's "class", usually...

bug
docs

This is a half-baked feature request, but I'm pretty sure this is too big for StackOverflow and I've done enough poking around to be relatively confident that this isn't currently...

enhancement