sphinx
sphinx copied to clipboard
The Sphinx documentation generator
### Describe the bug While building docs on readthedocs.org, arrived a this command: ``` /home/docs/checkouts/readthedocs.org/user_builds/thesys/envs/latest/bin/python -m sphinx -T -E -W --keep-going -b html -d _build/doctrees -D language=en . _build/html ```...
### Describe the bug I have just updated to sphinx 5.1.1 on FreeBSD 13.1 and the figures in the HTML output for the RTEMS documentation are not centered. The figures...
### Describe the bug I'm unable to build an existing project (which was created on an older version of sphinx) due to the type error. I've tried downgrading the package...
**Is your feature request related to a problem? Please describe.** Currently there is no way to explicitly exclude a base from an inheritance diagram. A great example is that I...
### Feature or Bugfix - Feature ### Purpose - Currently, Sphinx supports multiple glossaries, but the same term cannot appear twice. This is improved by adding an identifier to glossaries...
### Describe the bug This issue was initially opened by @rok here: https://github.com/pydata/pydata-sphinx-theme/issues/388. > When I want to copy a name of a function parameter I typically double-click it to...
### Describe the bug During tests with Sphinx 5.1.x I found that some of our company documentation projects do not work any more, see https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter/issues/19. This error only happens if...
### Describe the bug When searching the [RTD of the WarpX](https://warpx.readthedocs.io/en/latest/index.html) project, sometimes no results are found even though there are matching parts of the documentation but the string is...
Fixes #10809 * the option `autosummary_ignore_module_all` when set to `False` adds members to module's members entry that will be used for autodoc, but otherwise it ignores it. As such, if...