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

### Describe the bug Hi Team, when we use Sphinx to render documents, we encounter a scene where we need to list the overloaded methods of the parent class in...

bug
autodoc

Subject: Allow calling the quickstart Makefile with `make -f` ### Feature or Bugfix - Bugfix ### Purpose - This PR modifies the default Makefile so that it can be called...

cmdline
proposal

**Is your feature request related to a problem? Please describe.** Allow authors to create an admonition that does not contain a title. **Describe the solution you'd like** Allow not having...

enhancement

### Describe the bug @AA-Turner Thank you for doing release work for Sphinx. I am Sphinx maintainer in Debian and we are importing upstream tarballs into our version control system....

bug

### Describe the bug When using the quickstart project, calling the Makefile with the `--file` option (https://www.gnu.org/software/make/manual/make.html#index-_002d_002dfile) results in a weird error: ``` make -f /path/to/doc/Makefile -j 1 html Application...

bug

### Describe the bug When a page doesn't use mathjax (:math:) it doesn't load mathjax. This breaks titles in the table of contents that do use math. ### How to...

bug

When having an object with type hints, e.g. like this function: ```python def f(x: typing.Union[float, str]): ... ``` The type hint is converted to the following HTML code in the...

enhancement

### Describe the bug When the search contains umlauts, I get no search results, despite the fact, that pages with ä,ö and ü exists. ### How to Reproduce Simply add...

bug
help wanted
html search

### Describe the bug In [Yocto documentation](https://git.yoctoproject.org/yocto-docs), we use a custom extension to do some search and replace in literal blocks, see https://git.yoctoproject.org/yocto-docs/tree/documentation/sphinx/yocto-vars.py. We discovered (https://git.yoctoproject.org/yocto-docs/commit/?id=b7375ea4380e716a02c736e4231aaf7c1d868c6b and https://lore.kernel.org/yocto-docs/CAP71WjwG2PCT=ceuZpBmeF-Xzn9yVQi1PG2+d6+wRjouoAZ0Aw@mail.gmail.com/#r) that this...

wontfix
markup
api

**Is your feature request related to a problem? Please describe.** In my project, I am relying on `multipledispatch` library to allow for multiple dispatching of functions. Following the closed [feature...

enhancement
autodoc