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

### Describe the bug While implementing some feature, I wanted to test the latter by selectively running some tests but I found that the tests are not executed in an...

type:bug
type:tests

### Describe the bug I'm working on the Dutch Blender Manual translation, and I'm quite positive that "Note" in most of the cases should be translated to "Opmerking" instead of...

i18n

**Is your feature request related to a problem? Please describe.** If you define a dataclass descriptor field then it doesn't return `self`, so sphinx doesn't know to look for the...

type:enhancement
extensions:autodoc
expert

### Describe the bug If a [descriptor-typed dataclass field](https://docs.python.org/3/library/dataclasses.html#descriptor-typed-fields) without a default value (item 3 in the screenshot) is used in a class `Foo`, then the field cannot be accessed...

type:bug
extensions:autodoc

### Describe the bug As per the documentation, gettext_additional_targets should allow you to specify additional targets for translation. But, it is not identifying directives like `if-builder` and `panels`. ### How...

help wanted
type:proposal

Thank you for building and maintaining Sphinx, it is a great project ! ------------------------------------------------------------------------------------------------------------------------------ **Is your feature request related to a problem? Please describe.** I have been part of the...

type:enhancement
help wanted
internals:internationalisation

### Describe the bug It is of course not the responsibility of the Sphinx maintainers to fix broken themes, but maybe there can be some backwards-compatibility effort to avoid some...

type:proposal
html theme

**Is your feature request related to a problem? Please describe.** I am currently using [PEP 702](https://peps.python.org/pep-0702/) to mark functions and classes as deprecated in Python, like this: ```python from typing_extensions...

extensions:autodoc

### Feature or Bugfix - Bugfix ### Purpose - refs: #10322 - Filter members having invalid characters in python (like `CMYK;I`).

type:bug
extensions:autodoc

### Feature or Bugfix - Refactoring ### Purpose - Fix typo Hello. I'm back from a long break.

internals:refactoring