sphinx

sphinx copied to clipboard

[tracker] [tests] Python test suite reliability: striving for non-flaky, parallelizable, random-orderable tests.

1

This is an umbrella issue to track progress making the Sphinx test suite reliable. That means: * No flaky tests. * Tests can run in parallel. * Tests are independent...

jayaddison

### Describe the bug I know it's an edge case but I think I find a bug in the add_css_file method. I build a sphinx extention (https://github.com/sphinx-contrib/icon) to create an...

12rambau

viewcode.py gives "list index out of range"

5

### Describe the bug When attempting to build the docs for our project at we get an exception: ``` Exception occurred: File "/opt/hostedtoolcache/Python/3.9.15/x64/lib/python3.9/site-packages/sphinx/ext/viewcode.py", line 268, in collect_pages lines[start]) IndexError: list...

raar1

Move ``util.typing.restify()`` to ``autodoc``

1

> `restify` is only ever used within `sphinx/ext/autodoc`. I get that this would be a breaking change, but it really should be moved there, since it has nothing to do...

AA-Turner

`sphinx.ext.autosummary` does not process a subpackage, even though it imports without errors

5

### Describe the bug I'm trying to generate API documentation from [this repository](https://github.com/JesseTG/libretro.py) using `sphinx.ext.autosummary`. However, the contents of [`libretro.driver`](https://github.com/JesseTG/libretro.py/tree/0d23b01032b9c2f1e5a09677d5a06dffcd63b190/src/libretro/driver) are not being processed. Here are some more details: -...

JesseTG

LaTeX: long list of authors overflows in margin of title page

4

**To Reproduce** Steps to reproduce the behavior: Create using sphinx-quickstart a new project and respond with a long list of authors to the "author" prompt. Then do `make latexpdf`. For...

jfbu

[autodoc] undefined reference for aliased type annotation in the class constructor

11

### Describe the bug i'm seeing a build error because `rx.PyDiGraph` cannot be found ### How to Reproduce see https://github.com/danieleades/sphinx-graph/actions/runs/8684807082/job/23813057033?pr=143 ### Environment Information ```text python 3.12, sphinx 7.2.6 ``` ###...

danieleades

Autodoc fails on enums containing special characters

3

### Describe the bug Consider the following enum: ```python3 Colorspace = Enum("Colorspace", "RGB RGBA L LA 1 CMYK CMYK;I P PA") ``` Autodoc'ing this enum will yield the following error:...

mara004

Make html_sourcelink_suffix default to an empty string

3

Currently, html_sourcelink_suffix defaults to `.txt`. This means that all of the sourcelinks have `.txt` appended to them. So for example, `myfile.rst` becomes `myfile.rst.txt`. I believe that this was done in...

choldgraf

`sphinxcontrib-*` builder packages should follow same versioning scheme as Sphinx

1

(I'm filing this here since the issue trackers for the various `sphinxcontrib-*` builder packages are disabled). We recently(ish) released new versions of the split-out `sphinxcontrib-*` builder packages, namely: - `sphinxcontrib.applehelp`...

stephenfin