sphinx

sphinx copied to clipboard

Allow including nested captions in `toctree` function provided to HTML theme templates

2

**Is your feature request related to a problem? Please describe.** I'm exploring ways to enable more flexible/complex site structures with Sphinx, as part of a Sphinx theme (https://github.com/pradyunsg/lutra/). One of...

pradyunsg

apidoc: SPHINX_APIDOC_OPTIONS support options not ending with a :

4

## Brief `apidoc` forces that the `SPHINX_APIDOC_OPTIONS` are starting and ending with a `:`, but there are sphinx options which do not end with a `:`, which are then unusable....

raabf

### Describe the bug Recently, the unit tests of my project https://github.com/mgeier/sphinx-last-updated-by-git started to fail because Sphinx has changed the way how some dependencies of source files are determined. I...

mgeier

Python 3.11: "WARNING: Literal block expected; none found"

2

### Describe the bug When building docs with enums like this: ```rst .. autoclass:: Transpose :members: :undoc-members: ``` Referring to code like this: ```python class Transpose(IntEnum): FLIP_LEFT_RIGHT = 0 FLIP_TOP_BOTTOM...

hugovk

autodoc failed to import module even though module is in path

4

**Describe the bug** My project structure is like this: ``` . ├── service1 │   ├── README.md │   ├── utils │   │   ├── __init__.py │   │   └── some_code.py │   ├── routines...

sam-hoffman

Return type does not get linked if napoleon_use_rtype = True

11

**Describe the bug** If I set `napoleon_use_rtype` to `False`, I get a nice link to the type of the return value. However, if I change `napoleon_use_rtype` to `True`, because I...

SwampFalc

.. include:: directive shouldn't care about filename extension

4

_index.rst_: .. |subst| replace:: Substitution .. include:: a.rst .. include:: b.rst _a.rst_: A: |subst| _b.rst_: B: |subst| The output is correct: > A: Substitution > > B: Substitution But building...

brechtm

### Problem When I generate documentation using `sphinx.ext.autodoc` for my [`attrs`](https://www.attrs.org/en/stable/) classes' `__init__` (using `:special-members: __init__`), the parameters for `__init__` aren't documented. ### Solution I'd like autodoc to populate the...

EpicWink

Allow a CLI that does not handle Exceptions.

3

**Is your feature request related to a problem? Please describe.** I would like to use my IDE's debugger to find out where SphinxErrors are coming from. In particular, I got...

Jacob-Stevens-Haas

ext: allow builders to override support for linkcode references

4

### Feature or Bugfix - Feature ### Purpose The original `sphinx.ext.linkcode` extension will only include references into a doctree for `html` builders. Custom builders who would like to handle linkcode...

jdknight