sphinx

sphinx copied to clipboard

use ruff's 'extend exclude'

4

ruff's docs list 'extend exclude' as the preferred option. that reduces the boilerplate, and allows the config to only list the *differences* from standard python config

danieleades

[8.x] Remove Intersphinx Legacy Format and Fix intersphinx cache loading in incremental builds

7

Fix #11466. - Add test for intersphinx incremental builds. So, the issue was that were ordering lists of `(str, dict)`. However, this only occurred if we changed the URL of...

picnixz

Python domain: Correctly match when signature simultaneously has annotations for both the function and the return type

2

### Feature or Bugfix - Bugfix ### Purpose - Fixes python signature regex to successfully parse simultaneous annotations of function and return type. ### Detail Python domain fails to match...

arashbm

Do not add checksums to css files if building using the htmlhelp builder

4

Subject: The windows help compiler requires that css links don't have a query component. This PR disables the checksum for css files if the htmlhelp builder is used. ### Feature...

mkay-sh

Static templates: also support filenames with .jinja suffix

2

### Feature or Bugfix - Feature ### Purpose - Makes it clearer that static template files within the application are [Jinja](https://jinja.palletsprojects.com/) templates by using the [suggested](https://jinja.palletsprojects.com/en/3.1.x/templates/#template-file-extension) (note: not strictly required)...

jayaddison

Config option `python_display_short_literal_types` not working

1

### Describe the bug Setting config value [`python_display_short_literal_types`](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-python_display_short_literal_types) to `True` has no effect. Output from the steps below. The docs show `Literal`, but with this config option `Literal` should not...

user27182

Autosummary lists functions but does not generate documentation pages

3

### Describe the bug When using autosummary with recursion, functions in the summaries are not clickable while modules are. There is no page with full documentation generated for each function....

aeisenbarth

Pass autosummary options to recursive template

1

Subject: Pass autosummary options to recursive template ### Feature or Bugfix - Bugfix ### Purpose - When using autosummary with `:recursive:`, options like `:nosignatures:` were not passed, so that nested...

aeisenbarth

Subject: Add `start_line` and `end_line` information in `linkcode` ### Feature or Bugfix - Feature ### Purpose - Allow the `linkcode` extension to add a line anchor in the generated link...

u1735067

Make hidden toctrees append their content after everything else in their section

26

Fundamentally, this is a workaround to the fact that the following is not possible in `rst` ```rst Heading 1 ======= Content under heading 1 Heading 2 ---------- Content under heading...

eric-wieser