Commit Graph

20999 Commits

Author SHA1 Message Date
Adam Turner
ffd7b786d5 Bump version 2024-07-15 09:40:29 +01:00
Adam Turner
e938849769 Bump to 7.4.0 final 2024-07-15 06:01:44 +01:00
github-actions[bot]
f250270149
[bot]: Update message catalogues (#12563)
Co-authored-by: AA-Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-15 06:00:12 +01:00
Adam Turner
9f5f260949 Use `:py:class: for typing.Annotated` 2024-07-15 05:55:49 +01:00
Adam Turner
4e8500c002 Make some typographical edits to CHANGES 2024-07-15 05:54:01 +01:00
Adam Turner
f10f0b6fb5
Various miscellaneous improvements (#12578) 2024-07-15 05:52:47 +01:00
Adam Turner
b1ed87eb1c Clarify "res" to "resolution" 2024-07-15 05:37:41 +01:00
danieleades
d5df528e8c
Shrink the mypy whitelist for `sphinx.util.display` (#12570)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-07-15 05:34:43 +01:00
Adam Turner
313627e4f6 Bump Ruff to 0.5.2 2024-07-15 05:22:04 +01:00
Adam Turner
51a964cc8c Use absolute imports in `sphinx` 2024-07-15 05:22:04 +01:00
Bénédikt Tran
2a30bb661f
Fix PEP 695 output for classes in the LaTeX builder (#12561) 2024-07-15 05:17:36 +01:00
Adam Turner
aeebfabe09
Add `include-read to the events overview; sort core_events` (#12576) 2024-07-15 05:06:26 +01:00
Chris Sewell
d8fa98e46a
Add a `write-started` event (#12567)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-07-15 04:59:06 +01:00
Adam Turner
fdcf185a0d Add missing PR number in CHANGES 2024-07-15 04:40:03 +01:00
Adam Turner
490b264203 Sort CHANGES into chronological order 2024-07-15 03:56:24 +01:00
Adam Turner
c4fb47310f
Remove `sphinx.environment` from the no-any-generics whitelist (#12575) 2024-07-15 03:49:24 +01:00
Adam Turner
00544bb997
Remove `sphinx.builders` from the no-any-generics whitelist (#12574) 2024-07-15 02:27:03 +00:00
Adam Turner
edd21a5b7c
Remove `sphinx.testing` from the no-any-generics whitelist (#12573) 2024-07-15 02:09:18 +00:00
danieleades
f4bb9ca112
Shrink the mypy whitelist: `sphinx.application` (#12568)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-07-15 03:04:10 +01:00
Adam Turner
3456ff3ca3
Add all admonitions to `directives.rst` (#12572)
Also improve documentation for the *versionchanged* directives.
2024-07-15 02:26:05 +01:00
Adam Turner
0f38c9c15d Emend various spelling errors 2024-07-15 02:16:34 +01:00
Adam Turner
7b570c06a1 Standardise on a common directive for describing code snippets 2024-07-15 02:15:52 +01:00
Adam Turner
1252c7b549 Use "rst" consistently for code and highlighting directives 2024-07-15 02:15:52 +01:00
Adam Turner
f2640a4286 Standardise on "reStructuredText" over "reST" in documentation 2024-07-15 02:15:52 +01:00
Adam Turner
26576590ed Make the domain referencing role targets more specific 2024-07-15 01:59:42 +01:00
Tim Hoffmann
00758033d3
[docs] CSS style improvements (#12546)
- increase paragraph line-height to 1.5
- Adapt the border color for all warning/error like admonitions
2024-07-14 08:02:02 +02:00
Chris Sewell
cbf0b8e419
[docs] fix changelog include (#12564)
Use `include-read` instead of `source-read` for special content transform. 
In-particular, this fixes an issue that `docs/changes.rst` would not re-build, when `CHANGES.rst` was changed.
2024-07-14 06:35:35 +02:00
Adam Turner
9e6276feda
Fix git pathspec for translations workflow (#12566) 2024-07-14 05:27:38 +01:00
Adam Turner
51905162a3
Restrict the translations PR to only changes under `sphinx/locale/` (#12565) 2024-07-14 05:23:06 +01:00
Chris Sewell
41b363dbff
[rst] Add level option to rubric directive (#12506)
This commit adds a `level` option to the `rubric` directive, which propagates a `level` attribute to the `rubric` node,
and allows renderers to select a specific heading level.

Logic for this attribute has been added to the HTML5 and LaTeX builder.
2024-07-14 05:52:58 +02:00
James Addison
35e7bfc347
linkcheck: Ignore URLs that respond with non-Unicode content (#12197) 2024-07-14 03:48:38 +01:00
Lingyu Hu
f0d8e2ef5e
Provide a better error message if the master document is not included in the project documents (#12011) 2024-07-14 03:22:39 +01:00
Tim Hoffmann
e04b0d4bec
Simplify the quickstart index template (#12500)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-07-14 01:30:27 +01:00
Jakob Lykke Andersen
e08f12f848
toctree: Use document nesting instead of domain nesting when adding domain objects (#12367)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-14 01:16:26 +01:00
David Stansby
159c26715b
Display `typing.Annotated` metadata in the Python domain (#11785)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-07-14 00:52:55 +01:00
Adam Turner
02c265ce23 Force the features added list to be compact 2024-07-14 00:50:17 +01:00
Adam Turner
bd6f87dd6a
Use Babel errors for the PR body in the transifex workflow (#12562)
Currently, when Babel fails for a locale, the entire PR fails.
Instead, just skip compiling the catalogue for that locale, and report the failures in the body of the PR to be more visible.
2024-07-13 18:26:32 +01:00
James Addison
7011459fe9
linkcheck: Use old-style string formatting to fix gettext (#12560) 2024-07-13 17:45:16 +01:00
Jean-François B
aa6dac81ec
LaTeX: Revamp the styling of all admonitions (#12508)
In LaTeX output, all admonitions now also have a title row with icon.

The ``xcolor`` LaTeX package is now required and the ``fontawesome5`` LaTeX package is needed for the icons.
2024-07-13 17:33:22 +01:00
Jean-François B
e49e2933bb
LaTeX: Use the babel LaTeX package by default for 'lualatex' with French (#12557)
Previously ``polyglossia`` was used by default.
2024-07-13 09:02:43 +01:00
Adam Turner
469a809ead
Increase minimum required dependency versions (#12556) 2024-07-13 08:59:24 +01:00
Adam Turner
d2f426637d
Require Docutils 0.20 or greater (#12555) 2024-07-13 08:20:13 +01:00
Adam Turner
063c97304d
Simplify the type of configuration value descriptions (#12553)
There's no real reason to have the empty string as a description, 
and hence we can just make the type ``str`` rather than a union.
2024-07-13 07:35:39 +01:00
Adam Turner
3b19a7b4ba Add missing `docutils` warning type in the documentation 2024-07-13 07:16:58 +01:00
Trevor Bekolay
2c0943784c
Disallow module cycles in autosummary (#6792)
Consider the following piece of reST::

  .. automodule:: sphinx.ext.autosummary
     :members:

     .. autosummary::

        sphinx.ext.autosummary.Autosummary

This inserts an autosummary after the module docstring, but before
the members of the module. Without the change in this commit, this
would fail because `import_by_name` would attempt to import::

    sphinx.ext.autosummary.sphinx.ext.autosummary.Autosumary

because the prefix (from the parent) is `sphinx.ext.autosummary`,
and the name is `sphinx.ext.autosummary.Autosummary`, which is able
to be imported from `sphinx.ext.autosummary`, but is not the way
that anyone would want to refer to it.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-13 06:37:50 +01:00
Chris Sewell
78c8b4d323
Add optional description argument to app.add_config_value (#12549)
Sphinx (+ extensions) has a lot of available configuration variables for users,
allowing for the co-location of a short description on the configuration value,
can be utilised by external tools to provide better sphinx authoring support.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-07-12 19:40:36 +02:00
Chris Sewell
316451de81
Add docutils type, to warnings originating from docutils (#12550)
As per other warning types, this helps users to better understand the root of the problem.
2024-07-12 19:02:44 +02:00
Rafael Fontenelle
9234d0b08d
Add missing backtick to close literal role in configuration.rst (#12547) 2024-07-11 21:29:52 +01:00
alvinhochun
41ee3be2cc
Do not add a language fallback by the stripping country code (#9635) 2024-07-11 12:46:28 +01:00
James Addison
a6c2bdd371
Rename template files in Sphinx to use the `.jinja` extension (#12364) 2024-07-11 12:31:35 +01:00