Bénédikt Tran
48a345b7c5
Improve type hints for `sphinx.ext.autodoc.mock` ( #12280 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-04-22 23:23:57 +01:00
Adam Turner
2361db5748
Enable more Ruff checks
2024-04-22 23:09:01 +01:00
Adam Turner
740b964d45
fixup! Elaborate a little more in the warning message for `config.cache`
2024-04-17 21:50:46 +01:00
Adam Turner
141f3ecdf3
Elaborate a little more in the warning message for `config.cache`
2024-04-17 21:24:11 +01:00
James Addison
943f6fbf9a
Fix test expectations for enum rendering on Python 3.12.3 ( #12293 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-04-17 04:18:52 +01:00
Adam Turner
7bf847d2b9
Fix the valid types check for `Any in sphinx.config`
2024-04-17 02:27:21 +01:00
Adam Turner
09d05a0858
Don't render types with `Optional[...]`
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-04-15 01:35:47 +01:00
James Addison
67303920fe
Make the test suite connectivity-agnostic ( #12095 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-04-12 23:32:12 +01:00
James Addison
532ad0306e
linkcheck: Make the new 'timeout' status opt-in ( #12023 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-04-12 23:18:22 +01:00
Adam Turner
b30088d68f
Bump Ruff to 0.3.7
2024-04-12 21:04:51 +01:00
Adam Turner
44a42d53af
Add basic tests for `_ConfigFile`
2024-04-11 19:01:17 +01:00
Adam Turner
8976fa4498
Support `theme.toml`
2024-04-11 19:01:17 +01:00
Adam Turner
6fd8b30043
Parse `theme.conf to a new _ConfigFile` type ( #12254 )
2024-04-10 00:10:26 +01:00
Adam Turner
3421e5382a
Narrow `Generator[T, None, None] types to Iterator[T]` ( #12241 )
2024-04-09 03:26:44 +01:00
Bénédikt Tran
db4939f007
[misc] update wording of `versionadded to Added in [...]` ( #12184 )
...
Motivated by the community feedback, the wording of ``versionadded`` is changed
from ``New in [...]`` to ``Added in [...]``.
2024-04-05 13:32:55 +02:00
Bénédikt Tran
f7a1397d6c
[console] enhance detection and elimination of known ANSI escape sequences ( #12216 )
...
This PR improves the logic for detecting and eliminating ANSI color codes and other escape sequences introduced by Sphinx. ANSI escape sequences that are not natively known to Sphinx are not eliminated (e.g., VT100-specific functions).
2024-04-04 12:35:38 +02:00
James Addison
df3cde65fa
[tests] linkcheck: bind each test HTTP server to a unique port per-testcase ( #12126 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-04-04 11:25:53 +02:00
Chris Sewell
430866e029
👌 Add warning log for config values that cannot be cached ( #12203 )
...
As a user and/or extension developer, it can be a source of confusion when,
on performing a `sphinx-build` for a cached project,
an unchanged configuration variable is always marked as changed (triggering a full rebuild).
This is often due to the variable being an unpicklable value,
which is silently omitted from the cache (i.e. the `environment.pickle`).
This commit introduces a specific warning for when a configuration variable is omitted from the cache,
allowing users to understand the root of the problem.
2024-03-27 12:59:24 +01:00
Chris Sewell
448cb9931d
🔧 CI: fix Python 3.13 tests ( #12210 )
2024-03-27 12:45:24 +01:00
James Addison
bfce4f54b0
[HTML search] include partially-matched document titles in search results ( #12041 )
...
Co-authored-by: William Lachance <wlach@protonmail.com>
2024-03-26 12:18:26 +01:00
Chris Sewell
04bd0df100
👌 Improve external role warnings (and revert object fallback) ( #12193 )
...
The key issue this commit seeks to address, is that existing tools / documentation often lead users to mistakenly use object types and not role names, a classic example being `function` not `func`
Previously, the warning message for using e.g. `` external:function`target` `` (with `py` as the default domain), would be:
```
WARNING: role for external cross-reference not found: function
```
This gives no information to the user on how to fix the issue, even though there is actually quite an easy fix
This commit adds logic to create more specific / helpful warning messages, e.g.
```
WARNING: role for external cross-reference not found in domains 'py', 'std': 'function' (perhaps you meant one of: 'py:func', 'py:obj')
```
This goes through the same original logic but, if the role is not found, it will look if the role name is actually an available object type on the domain(s), and then suggest its related roles.
This commit also reverts #12133 , which provided a (silent) fallback to auto convert an object type to a role name.
2024-03-25 14:39:51 +01:00
James Addison
0ef96a7d52
[tests] fix flakiness of `test_linkcheck_exclude_documents` ( #12189 )
2024-03-25 11:48:03 +01:00
Bénédikt Tran
f26d492d6d
[config] protect `is_serializable` against circular references ( #12196 )
2024-03-25 11:19:02 +01:00
Bénédikt Tran
885818bb7f
[tests] move utilities and static data into dedicated modules and remove `html5lib` ( #12173 )
...
Since #12168 , HTML files are now XML compliant, hence ``html5lib`` is no more needed as a testing dependencies.
2024-03-25 11:03:44 +01:00
Bénédikt Tran
f24eef7b6b
[cleanup] deprecate `sphinx.testing.util.strip_escseq in favor of sphinx.util.console.strip_colors` ( #12186 )
2024-03-24 00:43:54 +01:00
Bénédikt Tran
d91ba115bd
Verify that an asset file to be copied exists ( #12183 )
2024-03-23 14:57:32 +01:00
Chris Sewell
66fa790b3a
[tests] Add basic build test for all builtin themes ( #12168 )
...
Add `tests/test_theming/test_theming.py::test_theme_builds`, which is a parametrized test against all builtin sphinx HTML themes, that tests:
1. that the themes builds without warnings for a basic project, and
2. that all `.html` files it produces are valid XML (see https://html.spec.whatwg.org/ )
https://pypi.org/project/defusedxml/ was added to the test dependencies, in order to safely parse the XML
This required one fix for `sphinx/themes/basic/search.html`, and one for `sphinx/themes/bizstyle/layout.html`
Also, `tests/test_theming` was removed from the `ruff format` exclude list
2024-03-22 12:57:34 +01:00
danieleades
6c92c5c0f3
[lint] bump ruff version ( #12170 )
...
Co-authored-by: daniel.eades <daniel.eades@seebyte.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-22 10:33:42 +01:00
James Addison
4eede5c534
[tests] Increase timeouts for linkcheck build tests. ( #12166 )
...
This is an attempt to resolve intermittent failures of the linkcheck tests currently occuring on the GitHub CI
2024-03-21 21:46:27 +01:00
James Addison
d7c94d1696
[cleanup] test utils: more concise BaseHTTPRequestHandler references. ( #12158 )
2024-03-21 15:08:49 +01:00
Bénédikt Tran
da0733b338
[autodoc] fix rendering of enumerations inheriting from mixin and data types ( #11596 )
2024-03-21 12:36:36 +01:00
James Addison
078a80a42d
[refactor] test utils: simplify signatures and remove from ruff exclusion list. ( #12155 )
...
Apply some small method-signature cleanups in `tests/utils.py`,
and remove it from the `ruff format` exclusion list.
2024-03-21 11:08:35 +01:00
James Addison
b7f708dc63
[tests] utils: refactor type-hint signatures. ( #12144 )
...
Consolidate the provision of a single `http_server` utility method, with `tls_enabled` as a boolean flag,
and rework type annotations to make them more understandable.
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
2024-03-20 23:13:41 +01:00
Chris Sewell
565d4104d5
👌 Handle external references pointing to object types ( #12133 )
...
This commit fixes the issue of `objects.inv` denoting object names, whilst the `external` role only allows for role names.
As an example, take the `objects.inv` for the sphinx documentation, which contains:
```
py:function
compile : usage/domains/python.html#compile
```
A user might understandably expect that they could reference this using `` :external:py:function:`compile` ``, but actually this would previously error with:
```
WARNING: role for external cross-reference not found: py:function
```
this is because, `function` is the object type, yet `external` expects the related role name `func`.
It should not be necessary for the user to know about this distinction,
so in this commit, we add logic, to first look if the name relates to a role name (as previous, to not be back-breaking) but, if not, then also look if the name relates to an object that has a known role and, if so, use that.
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-19 13:42:50 +01:00
Chris Sewell
b0f096f440
✨ Add show_warning_types configuration variable ( #12131 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-19 10:22:28 +01:00
James Addison
7894b5a269
[tests] linkcheck: add test coverage for behaviour of a locally-existing file. ( #12128 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-18 18:36:22 +01:00
Bénédikt Tran
ff252861a7
[tests] add missing `@pytest.mark.sphinx` markers ( #12125 )
2024-03-18 11:16:15 +01:00
Bénédikt Tran
6ac2210109
[tests] use deduced `srcdir` instead of an explicit one ( #12124 )
2024-03-18 10:59:48 +01:00
James Addison
bf0bec3b4b
[search] filter script and style elements from search result summary text. ( #12057 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-17 15:14:03 +01:00
danieleades
4f7318767c
[lint] extend FURB lints ( #12088 )
2024-03-17 12:06:39 +01:00
Bénédikt Tran
57e302ed74
[lint] run `mypy on tests/test_addnodes.py` ( #12111 )
2024-03-16 18:38:22 +01:00
Bénédikt Tran
b0ded2e624
[lint] run `mypy on test_application.py` ( #12112 )
2024-03-16 18:29:44 +01:00
Bénédikt Tran
2df5b0a8ab
[lint] whitelist all test files except configuration and utils in tests ( #12109 )
2024-03-16 18:06:58 +01:00
James Addison
5695b76f05
[tests] epub: skip the epubcheck test if Java or epubcheck itself are not found ( #12098 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-15 12:02:41 +01:00
Bénédikt Tran
98d0cc8602
[tests] skip tests that need remote content if host is offline ( #12091 )
2024-03-14 15:33:24 +01:00
Bénédikt Tran
c86e90842f
[autodoc] add support for singledispatchmethod class methods ( #11284 )
2024-03-14 12:26:35 +01:00
Bénédikt Tran
dbb4da375f
[tests] correctly intercept or suppress warnings in tests ( #12085 )
2024-03-14 11:45:45 +01:00
danieleades
92380e60d1
[lint] add RUFF005 lint ( #12068 )
...
Co-authored-by: daniel.eades <daniel.eades@seebyte.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-14 11:26:30 +01:00
danieleades
fb91cb3f43
[lint] add FURB105 lint ( #12069 )
...
Co-authored-by: daniel.eades <daniel.eades@seebyte.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-14 11:05:40 +01:00
danieleades
d74a450213
[deps] bump ruff version ( #12065 )
...
Co-authored-by: daniel.eades <daniel.eades@seebyte.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-14 10:42:55 +01:00
James Addison
c6bd97ceae
Revert "tests: implement readiness check before yielding local-http(s) test servers" ( #12078 )
2024-03-14 09:01:17 +01:00
James Addison
5523c9bbe4
[tests] reflect changes to Enum signature in Python 3.13 ( #12054 )
2024-03-08 11:58:04 +01:00
James Addison
1bfddf81e0
[CI/CD] implement readiness check before yielding local-http(s) test servers ( #12050 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-08 11:16:31 +01:00
Will Lachance
ae51974e21
[search] fix multiple term matching edge case ( #11960 )
2024-03-03 18:01:10 +01:00
Will Lachance
1e4f80d7a4
[search] fix partial matches overwriting full matches ( #11958 )
2024-03-03 15:18:07 +01:00
Ned Batchelder
a7df31cfc6
[render] do not use a dash if there's no description to introduce ( #12035 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-03 10:46:11 +01:00
Bénédikt Tran
d8c301482d
[hotfix] fix a warning in #12036 ( #12043 )
2024-03-03 09:29:47 +00:00
Ned Batchelder
574519900e
[test] force rendering of ANSI colors for non-tty objects ( #12036 )
2024-03-02 17:36:41 +01:00
Michael Goerz
265ffeedbd
[intersphinx] allow case-insensitive match of label-refs through intersphinx ( #12033 )
2024-03-02 12:39:51 +01:00
Will Lachance
9a30ca7da1
[HTML search] use anchor for search preview ( #11944 )
2024-02-27 15:22:52 +01:00
James Addison
8aa5edd585
[config] copyright correction logic: handle year-to-year ranges without trailing authorship info ( #11914 )
2024-02-24 16:21:29 +01:00
Bénédikt Tran
707bfbd669
[gettext] fix flaky test on windows ( #11940 )
2024-02-24 13:34:52 +01:00
MatrixEditor
182053198d
Added support for `slice` objects in subscriptions ( #11981 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-02-14 14:45:30 +01:00
Bénédikt Tran
08386826fb
Add tests for `:manpage:` inside a title ( #11705 )
2024-02-14 10:33:09 +01:00
Bénédikt Tran
b587eb243a
Fix `:paramtype:` reference targets ( #11964 )
2024-02-14 00:04:49 +01:00
Frank Dana
41ab0f9a41
[test] add py:currentmodule unit test ( #11920 )
2024-02-03 16:14:26 +01:00
j-carson
cd2bf0a7e5
#11917 - Fix rendering of inherited members for Python 3.9 ( #11919 )
...
Co-authored-by: j-carson <j-carson@fastmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-02-03 10:46:13 +01:00
danieleades
f9c8943889
Use `# NoQA` consistently ( #11903 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-01-21 20:20:58 +00:00
Hugo van Kemenade
95b2cce9a0
Add a `versionremoved` directive ( #11905 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-21 20:12:52 +00:00
James Addison
2418e007ce
Support unary subtraction in annotation parsing ( #11904 )
2024-01-21 14:31:04 +00:00
Adam Turner
360c7a8022
Load themes through iteration rather than recursion
2024-01-21 03:59:31 +00:00
Adam Turner
99dd0cb4c6
Refactor `sphinx.theming` to prepare for iterative loading
2024-01-21 03:59:31 +00:00
Adam Turner
0ca2ddf924
Make various theme-related objects private
2024-01-21 03:59:31 +00:00
Adam Turner
e9dcfebcf9
Split the Python domain into multiple modules
...
``sphinx.domains.python`` was previously over 1,700 lines long
2024-01-19 03:55:47 +00:00
Adam Turner
1327ec71f2
Fix flake8 in test_build_latex
2024-01-19 03:28:23 +00:00
Adam Turner
4f962bf8e0
Split the C domain into multiple modules
...
``sphinx.domains.c`` was previously over 3,90 lines long
2024-01-19 03:28:23 +00:00
Adam Turner
7d30821e87
Split the C++ domain into multiple modules
...
``sphinx.domains.cpp`` was previously over 8,200 lines long
2024-01-19 03:28:23 +00:00
Adam Turner
38ac67bd6c
Use long `re` flags
2024-01-19 02:28:06 +00:00
Adam Turner
183dd51f4d
Explode the test matrix for test_build_latex_doc
2024-01-19 02:28:06 +00:00
Adam Turner
4c9364896e
Consolidate warnings tests in `test_build_warnings`
2024-01-19 02:28:06 +00:00
Adam Turner
6fab64fb55
Explicitly remove the `autodoc_fodder` module
2024-01-19 02:28:06 +00:00
Adam Turner
f195c4ae87
Various C++ domain performance improvements ( #11895 )
...
Authored-by: Jakob Lykke Andersen <Jakob@caput.dk>
Co-authored-by: Jakob Lykke Andersen <Jakob@caput.dk>
2024-01-19 02:20:43 +00:00
Adam Turner
e3b613aa37
Clean up global state in SphinxTestApp
2024-01-18 23:30:22 +00:00
Adam Turner
1785fc9352
Remove spurious blank lines
2024-01-18 01:26:17 +00:00
Adam Turner
311ca30564
Improve `check_xpath`
2024-01-18 01:21:09 +00:00
Adam Turner
898e50c2c7
Remove `flat_dict`
2024-01-18 01:16:49 +00:00
Adam Turner
0331bdec0e
Fix import order
2024-01-18 00:54:27 +00:00
Adam Turner
7800bf00dc
Split `test_domain_py`
2024-01-18 00:52:25 +00:00
Adam Turner
1cb9fc3e63
Split `test_build_html`
2024-01-18 00:52:25 +00:00
Adam Turner
462404cb25
Organise tests into directories
2024-01-17 03:56:35 +00:00
Adam Turner
841f2bd9b7
Remove unneeded uses of `flat_dict()`
2024-01-17 01:58:52 +00:00
Nicolas Peugnet
59cf4d4c35
Allow custom targets in the manpage role ( #11825 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-01-17 01:09:18 +00:00
James Addison
95fb0e5e57
Ensure that document titles are sorted in `searchindex.js` ( #11888 )
2024-01-17 01:08:29 +00:00
Adam Turner
569fde84d4
Happy New Year!
2024-01-16 22:13:47 +00:00
Adam Turner
55f3089981
Improve uses of `str.join` with a throwaway list
2024-01-16 22:06:34 +00:00
Shengyu Zhang
1b39b20479
Use `repr() when an enum has a custom __repr__()` ( #11879 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-01-16 20:28:22 +00:00
danieleades
f7fbfaa471
Enable various pydocstyle (D) rules ( #11878 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-01-14 21:13:46 +00:00
Adam Turner
23cef9b59a
Use `https://` where possible
2024-01-14 04:18:57 +00:00
James Addison
9e198c70fd
linkcheck: add a distinct 'timeout' reporting status ( #11876 )
2024-01-13 08:14:06 +00:00
James Addison
3b5d2afb9a
Fix 'test_html_scaled_image_link' for Docutils' HEAD ( #11863 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-10 01:01:47 +00:00
James Addison
5211c01646
Enable reporting HTTP 401 hyperlinks as broken in linkcheck ( #11684 )
...
Co-authored-by: picnixz <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-09 12:33:40 +00:00
Adam Turner
db9e476288
Increase the minimum supported version of Alabaster to 0.7.14 ( #11858 )
2024-01-08 19:49:04 +00:00
Adam Turner
18394ae96b
Add more types with an incorrect `__module__` attribute ( #11861 )
2024-01-08 18:25:05 +00:00
Adam Turner
e570f56022
Enable flake8-logging (LOG) rules
2024-01-04 04:16:13 +00:00
Adam Turner
1b4177540e
Enable RUF017
2024-01-04 04:12:26 +00:00
Adam Turner
97a83acb17
Enable RUF013
2024-01-04 04:12:26 +00:00
Adam Turner
9d6667d8f7
Enable Ruff perflint (PERF) rules
2024-01-04 04:12:26 +00:00
Adam Turner
3d98eeea79
Update Ruff to 0.1.11
2024-01-04 02:43:52 +00:00
Dimitri Papadopoulos Orfanos
460a63010f
Fix various spelling errors ( #11735 )
2024-01-04 02:37:44 +00:00
Adam Turner
efd24cf4ca
Defer computation of configuration values ( #11855 )
2024-01-04 02:23:45 +00:00
Adam Turner
4ce2d84761
Move special-case bool conversion to 'gettext'
2024-01-03 23:41:35 +00:00
Adam Turner
68af0ac2be
Make `Config.values` private
2024-01-03 22:17:11 +00:00
Adam Turner
259118d182
Narrow the type for configuration option 'valid_types' values
2024-01-03 21:51:39 +00:00
Adam Turner
fd23cf0256
Introduce a configuration option type
...
* Normalise rebuild values
* Ensure that the tuple interface continues to work
2024-01-03 19:58:55 +00:00
Dimitri Papadopoulos Orfanos
b9691c0ce6
Add some recent Ruff rules ( #11833 )
2024-01-02 01:22:08 +00:00
James Addison
d66d51ad8c
test_build_linkcheck: test_defaults: fix line-number assertion when using docutils 0.21b+ ( #11818 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2023-12-30 13:38:30 +01:00
danieleades
f7f4fb42b0
Enable more entire categories in Ruff ( #11816 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-12-29 09:55:28 +00:00
James Addison
246312287e
Resolve lint warnings reported by Ruff ( #11719 )
2023-12-28 06:51:32 +00:00
danieleades
64e7ba5e3f
Enable the entire pycodestyle category ( #11820 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-12-28 06:41:32 +00:00
Hugo van Kemenade
7d4ca9cb3e
Fix autodoc tests for Python 3.11 and later ( #11793 )
...
Since Python 3.11.7, 3.12.0 and 3.13.0a2, "list of weak references to the object (if defined)" was changed to "list of weak references to the object".
Add a version check to decide which text to assert.
2023-12-26 04:10:22 +00:00
Adam Turner
8878bee000
Replace the header image with a new SVG logo
2023-10-04 16:56:46 +01:00
James Addison
71d3eaee75
Add 'noindex' meta robots tag to the search results page ( #11700 )
2023-10-03 14:15:57 +01:00
Jakob Lykke Andersen
b9c85984d2
intersphinx: Group all std domain tests together
2023-09-21 23:04:42 +01:00
Bénédikt Tran
46f8f76e56
Fix the lazy loading conditions for MathJax ( #11597 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-21 18:18:09 +01:00
Aryaz Eghbali
abf42e901e
Skip all hidden directories in `CatalogRepository` ( #11667 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-21 09:30:26 +00:00
Bénédikt Tran
5fe0bd41eb
Strip ANSI control codes when writing to the warnings file ( #11624 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-09-21 10:01:07 +01:00
Adam Turner
cb0c6a359b
Add `sphinx.util._strip_escape_sequences`
2023-09-20 23:55:00 +01:00
Pietro Albini
8e768e6c23
Make `searchindex.js deterministic ( #11665 )
2023-09-16 04:36:51 +01:00
Vinay Sajip
f0c25a0ada
Raise a useful error if `theme.conf` doesn't exist ( #11671 )
2023-09-14 11:49:41 +01:00
Matt Wozniski
43d69755df
Leverage `importlib.reload` for reloading modules ( #11679 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-09-13 22:58:35 +01:00
Adam Turner
3d0110a95a
Enable test_cython on Python 3.12
2023-09-13 03:07:19 +01:00
Adam Turner
2a631f97ef
Restore support for YYYY copyright lines
2023-08-30 22:51:23 +01:00
Adam Turner
ff18318613
Add an `'include-read'` event ( #11657 )
2023-08-30 22:21:16 +01:00
Adam Turner
7d046a862f
Allow `?config=... in mathjax_path` ( #11659 )
2023-08-30 19:35:29 +01:00
Albert Y. Shih
4692208fde
Fix two relative link bugs in inheritance diagrams ( #11634 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-30 18:44:37 +01:00
Matt Wozniski
8248be31db
autodoc: Reset `sys.modules` on partial import failure ( #11645 )
...
If importing with ``TYPE_CHECKING is True`` fails, reset the state of ``sys.modules``
so that the attempt with ``TYPE_CHECKING is False`` may succeed.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-29 20:05:41 +01:00
Dmitry Shachnev
2f025a4b22
linkcheck: Fix conversion from UTC time to the UNIX epoch ( #11649 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-28 03:39:13 +00:00
Adam Turner
5e88b9f886
Fix the MoveModuleTargets transform ( #11647 )
...
This resolves a regression introduced in GH-10478
(commit 97d2c5da2f
2023-08-26 09:30:28 +00:00
Bénédikt Tran
76658c49a9
Fix `sphinx.ext.autodoc.preserve_defaults` ( #11550 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-17 01:19:25 +00:00
Adam Turner
9d8ef833db
Fix `test_inspect_main_noargs`
2023-08-16 23:49:30 +01:00
Adam Turner
e3f0342932
Enable E241 (Multiple spaces after comma)
2023-08-15 18:16:27 +01:00
Stephen Finucane
53a930f8c7
Fix C coverage support in `sphinx.ext.coverage` ( #11591 )
2023-08-15 14:50:15 +01:00
Bénédikt Tran
19018f01b6
Improve SigElementFallbackTransform fallback logic. ( #11311 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-15 14:25:25 +01:00
picnixz
2656f34848
Fix rendering of `Literal` annotations with enum values ( #11517 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-14 23:33:57 +01:00
Riccardo Mori
137b3adce1
Make stringify_annotation recursive on builtins with args ( #11570 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-14 19:28:12 +01:00
Halldor Fannar
0bad447070
Emit "source-read" events for files read via the `include` directive ( #11510 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: picnixz <10796600+picnixz@users.noreply.github.com>
2023-08-14 16:02:04 +01:00
Adam Turner
08dbaa793e
Fix SIM117 (use single 'with' statement)
2023-08-14 00:18:13 +01:00
Adam Turner
3600862477
Fix SIM118 (use `key in dict not key in dict.keys()`)
2023-08-14 00:18:13 +01:00
Adam Turner
1fae1470a4
Fix SLOT002 (subclasses of collections.namedtuple() should define `__slots__`)
2023-08-13 22:32:46 +01:00
Adam Turner
d80eab689d
Fix EM10{1,2} (exception must not use a string)
2023-08-13 22:11:15 +01:00
Adam Turner
b533ef1662
Fix DTZ00{0-4} (Do not use naive datetime objects)
2023-08-13 22:11:15 +01:00
Adam Turner
d4169a32e7
Use `parsedate_tz` in the linkcheck builder
2023-08-13 22:11:15 +01:00
Adam Turner
e010e24728
Fix B904 (raise exceptions with `raise ... from ...`)
2023-08-13 22:11:15 +01:00
Adam Turner
bbfd3cd248
Fix B023 (function definition does not bind loop variable)
2023-08-13 22:11:15 +01:00
Adam Turner
1dcc112608
Fix B006 (Do not use mutable data structures for argument defaults)
2023-08-13 22:11:15 +01:00
Adam Turner
92e60b3f15
Fix PGH003 (type: ignore comment must have parameters)
2023-08-13 22:11:15 +01:00
Adam Turner
e2ff04eafe
Fix RES102 (Remove unnecessary parentheses)
2023-08-13 22:11:15 +01:00
picnixz
af38180a14
Allow inline links in first line of Google style docstrings ( #11316 )
2023-08-12 07:24:28 +01:00
Adam Turner
0a42d91e7e
Fix `test_{html,latex}_warnings`
2023-08-12 06:40:55 +01:00
Adam Turner
7d8df06e19
Relax Pygments parsing on lexing failures
2023-08-12 06:27:16 +01:00
Adam Turner
7e9a2066c2
Be more ephemeral (in anchor link title text)
2023-08-12 05:30:38 +01:00
Adam Turner
2ef9728b6e
Mark idempotent translations as 'translated' ( #11580 )
2023-08-12 04:51:52 +01:00
Adam Turner
c19f0ac8e9
Clarify why `test_logging_in_ParallelTasks` fails on Windows
2023-08-12 04:24:09 +01:00
Adam Turner
1ea5a434b3
Fix `test_get_filename_for_language` on Windows
2023-08-12 04:23:56 +01:00
Adam Turner
1a47e3a8be
Fix `test_missing_reference` on Windows
2023-08-12 04:23:48 +01:00
Adam Turner
8111a3a211
Fix `test_html_inventory` on Windows
2023-08-12 04:23:33 +01:00
Adam Turner
a392f4d5f4
Fix `test_graphviz_svg_html` on Windows
2023-08-12 02:57:55 +01:00
Adam Turner
58b628263f
Deprecate `css_files and script_files` ( #11582 )
2023-08-12 00:46:44 +00:00
Adam Turner
818895a158
Placate `isort`
2023-08-12 00:27:13 +01:00
Adam Turner
42a6546404
Move `_file_checksum() to sphinx.builders.html._assets`
2023-08-12 00:20:00 +01:00
Adam Turner
44a7820cd9
Raise an error when local asset files contain a `?`
2023-08-11 22:07:07 +01:00
Adam Turner
177565584a
Tighten Pytest configuration ( #11577 )
2023-08-10 20:48:04 +01:00
Adam Turner
b91d763db8
Fix PT011 (`pytest.raises(ValueError)` is too broad)
2023-08-10 13:11:25 +01:00
Adam Turner
78976662d9
Fix PT003 (implied `scope='function'`)
2023-08-10 13:11:25 +01:00
Adam Turner
fb5b80c340
Fix PT007 (use lists in `pytest.mark.parametrize`)
2023-08-10 13:11:24 +01:00
Adam Turner
02e011e4ff
Fix PT006 (use tuples in `pytest.mark.parametrize`)
2023-08-10 13:00:48 +01:00
Adam Turner
976dd07ffe
Require Pygments 2.14 or later ( #11576 )
2023-08-10 11:35:45 +00:00
Adam Turner
8cabf08668
Cache the docname<->filename map in `Project` instances ( #11575 )
2023-08-10 12:25:38 +01:00
Adam Turner
4dd2ed4bde
Spring-clean `test_build_gettext` ( #11573 )
2023-08-10 09:20:48 +00:00
alvinhochun
c52d55ebd7
Exclude substitution definitions from the `gettext` builder ( #9846 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-10 10:01:25 +01:00
Adam Turner
6f5a99a05d
Refactor `sphinx.environment.adapters.TocTree` ( #11565 )
2023-08-09 15:43:26 +01:00
Albert Y. Shih
3e30fa36a2
Fix missing and broken links in inheritance diagrams ( #10614 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-08 20:32:58 +01:00
grayjk
ac2b7599d2
autosummary: Extract summary line after "e.g." ( #11196 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-07 22:20:30 +01:00
Adam Turner
8cd677f929
Add a new test for `_file_checksum`
2023-08-07 21:51:25 +01:00
Adam Turner
85ffb3b0fd
Fix `test_assets_order` for Pygments 2.16
2023-08-07 21:51:05 +01:00
Adam Turner
083d573b7c
Fix `test_dark_style` for Pygments 2.16
2023-08-07 21:04:14 +01:00
Dmitry Shachnev
8a990db49e
Update `test_captioned_code_block` for latest Docutils ( #11551 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-05 04:46:41 +01:00
Adam Turner
43ab23a61f
Merge branch '7.1.x'
...
# Conflicts:
# CHANGES
# sphinx/__init__.py
2023-08-02 02:58:30 +01:00
James Addison
06c1339bb3
Ensure that `linkcheck_anchors` is properly respected ( #11544 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-02 02:55:37 +01:00
Jean-François B
4958d2abf1
Fix flake8 E231 reported linting failure
2023-08-02 02:04:55 +01:00
Jean-François B
eb0499a696
Fix flake8 E231 reported linting failure
2023-07-30 15:00:55 +02:00
Adam Turner
629b862cde
Spring-clean `sphinx.testing.utils` ( #11534 )
2023-07-28 23:24:13 +01:00
Adam Turner
1cfb68d8be
Consistently name the object description options ( #11533 )
...
* The directive option ``:noindex:`` was renamed to ``:no-index:``.
* The directive option ``:noindexentry:`` was renamed to ``:no-index-entry:``.
* The directive option ``:nocontentsentry:`` was renamed to ``:no-contents-entry:``.
The previous names are retained as aliases, but will be deprecated
and removed in a future version of Sphinx (9.0 or later).
2023-07-28 22:30:26 +01:00
latosha-maltba
97d2c5da2f
Add the `:no-typesetting:` option for only creating targets ( #10478 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-28 19:43:27 +01:00
Christoph Hasse
fca33a203d
Add additional `stringify_annotation` tests ( #11027 )
2023-07-28 06:45:20 +01:00
benkrikler
762ed8540a
Add line numbers in `sphinx.ext.viewdoc` ( #6319 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-28 05:52:48 +01:00
Ralf Grubenmann
6178163cb1
Fix relative references in SVGs generated by `sphinx.ext.graphviz` ( #11078 )
...
Co-authored-by: Ralf Grubenmann <ralf.grubenmann@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-28 05:47:23 +01:00
Martin Liška
2c0b81d88b
Refactor `test_attrgetter_using` ( #11293 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-28 04:20:36 +01:00
Jorge Leitao
99f9209924
Add summary statistics to the coverage report ( #5474 )
...
The current implementation of ``sphinx.ext.coverage`` outputs which
methods,classes, and functions are documented.
This commit adds a short summary of this report in terms of
``documented objects / total number of objects``,
both per module and total.
The purpose of this is to support
a currently not mainstream but relevant use-case:
a coverage report on the number of objects that are documented.
By having the statistics on the report or on the stdout,
a regex expression can capture the coverage percentage
(e.g. ``re.search(r'TOTAL.*?([0-9.]{4,6}\%)', d).group(1)``)
and use it e.g. in another report, a status badge, etc.
Two options were added to the configuration to allow a table
to be printed in the report and/or to stdout.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-07-28 02:33:42 +01:00
Adam Turner
7cce00aa7d
Refactor `sphinx.util.inspect` and tests ( #11527 )
2023-07-28 02:05:40 +01:00
Adam Turner
49d8304670
Start using `pathlib.Path and deprecate sphinx.testing.path` ( #11526 )
2023-07-28 00:39:12 +01:00
James Addison
467e94dc62
object inspection: produce deterministic descriptions for nested collection datastructures ( #11312 )
...
``util.inspect.object_description`` already attempts to sort collections, but this can fail.
This commit handles the failure case by using string-based object descriptions
as a fallback deterministic sort ordering, and protects against recursive collections.
Co-authored-by: Chris Lamb <lamby@debian.org>
Co-authored-by: Faidon Liambotis <paravoid@debian.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-07-27 22:45:51 +01:00
Adam Turner
a01e1a21ac
Merge branch '7.1.x'
...
# Conflicts:
# CHANGES
# sphinx/__init__.py
# sphinx/config.py
2023-07-27 21:38:35 +01:00
Adam Turner
8452300d54
Fix multi-line copyright when `SOURCE_DATE_EPOCH` is set ( #11524 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2023-07-27 21:27:14 +01:00
Adam Turner
5cf3dce36e
Deprecate `md5 and sha1 wrappers in sphinx.util` ( #11512 )
2023-07-25 02:29:28 +01:00
Adam Turner
ad61e41157
Drop support for Python 3.8 ( #11511 )
2023-07-25 02:07:23 +01:00
Adam Turner
066e0fabc6
Add translation progress information ( #11509 )
...
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
2023-07-24 20:19:31 +01:00
picnixz
82bc15aec3
Enable skipping anchor verification on a per-URL basis ( #11489 )
...
Add a new ``linkcheck_anchors_ignore_for_url`` configuration variable.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-24 12:15:42 +01:00
picnixz
480630c649
Support PEP 695 and PEP 696 syntax in the Python domain ( #11444 )
...
* Generic classes can be documented with ``.. py:class::`` using PEP 695 syntax:
.. code:: rst
.. py:class:: Sequence[T]
* Generic functions can be documented with ``.. py:function::`` using PEP 695 syntax:
.. code:: rst
.. py:function:: foo[T](x: T)
* Default values for type bounds are supported.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-23 23:22:40 +01:00
James Addison
450ad637ac
Begin using session-based HTTP requests in the linkcheck builder ( #11503 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-23 22:23:08 +01:00
Adam Turner
ae866b1289
Avoid deprecated `Node.traverse method in test_node_translated_attribute`
2023-07-23 21:33:15 +01:00
danieleades
4de540efb6
Enable mypy 'strict optional' for 19 modules ( #11422 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-23 21:29:04 +01:00
Manuel Kaufmann
f4a47f1401
Keep the `translated` attribute on translated nodes ( #11502 )
...
This particular commit ensures that the ``translated`` attribute
is retained on translated nodes so that developers may use it
to improve the experience on translations.
This attribute can be useful to calculate
the translated percentage of a particular document,
to visually mark paragraphs as not translated,
and many other applications.
2023-07-23 21:00:24 +01:00
picnixz
12e7cff0b6
Allow using `rst_prolog` with a role in a document title ( #11445 )
...
Fix the field list field name recognition regular expression to avoid false positives,
as interpreted text roles may not be field name blocks.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-23 17:14:01 +01:00
James Addison
c583e0f9b0
Add client connection-pool contention coverage to the `linkcheck` tests ( #11402 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-07-23 16:24:12 +01:00
James Addison
2b333265cb
Add a connection-count measurement to the `linkcheck` tests ( #11374 )
2023-07-23 16:06:23 +01:00
Adam Turner
aabcda94cf
Add more information for the `test_gettext_dont_rebuild_mo` test ( #11500 )
2023-07-23 00:32:27 +01:00
Adam Turner
d71c781187
Re-structure the `linkcheck` builder ( #11499 )
...
Re-organise and re-structure the ``linkcheck`` builder:
- All functions defined within functions are factored out into top-level functions or class methods
- Classes and methods have been re-arranged (Builder, PostTransform, Checker, Worker)
- TLS verification on ``sphinx.util.requests`` has been changed to not pass the ``Config`` object all the way down
- The ``Hyperlink`` object now stores the document path
- ``BuildEnvironment`` and ``Config`` objects are used to extract properties and are not stored as class attributes
2023-07-23 00:01:41 +01:00
James Addison
566e4e74a0
Use HTTP/1.1 in linkcheck test webservers ( #11392 )
2023-07-22 20:12:32 +01:00
James Addison
bef7fc2e45
Refactor HTTP handlers in `linkcheck` builder tests ( #11426 )
2023-07-20 22:20:53 +01:00
Adam Turner
ce140e8155
Introduce artificial delay into `test_gettext_dont_rebuild_mo`
2023-07-20 21:51:08 +01:00
James Addison
13720de50c
Treat SSL failures as broken links in the linkcheck builder ( #11431 )
...
TLS operates at a lower layer than HTTP, and so if there is a TLS-related error from a host,
it seems unlikely that retrying with a different higher-layer protocol request
(HTTP GET instead of HTTP HEAD) could succeed.
We should not make additional HTTP requests that we do not believe will succeed.
2023-07-20 21:38:21 +01:00
James Addison
e45fb5e61b
Reduce the lifetime of `response` in the linkcheck builder ( #11432 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-20 21:14:00 +01:00
Adam Turner
d3c91f9512
Refactor `status_iterator`
2023-05-15 10:43:55 +01:00
Stefanie Molin
e09d02e440
Allow `copyright` to contain multiple entries ( #10983 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-11 22:43:48 +01:00
TLouf
86b07d4a97
Allow multi-line object description signatures ( #11011 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Jean-François B <2589111+jfbu@users.noreply.github.com>
Co-authored-by: TLouf <loufthomas@gmail.com>
2023-05-11 14:28:57 +01:00
Adam Turner
ae206694e6
html builder: Append CRC32 checksum to asset URIs ( #11415 )
2023-05-11 05:19:31 +01:00
Adam Turner
706f5f9cc8
Warn on deprecated Python-specific index types ( #11412 )
2023-05-09 22:57:39 +01:00
James Addison
c9d0933e5d
linkcheck: Use context managers for HTTP requests ( #11318 )
...
This closes HTTP responses when no content reads are required, as
when requests are made in streaming mode, ``requests`` doesn't know
whether the caller may intend to later read content from a streamed
HTTP response object and holds the socket open.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-09 17:09:35 +01:00
Adam Turner
ad473730a3
Remove HTML 4 support ( #11385 )
2023-04-28 11:32:12 +01:00
Adam Turner
3c4e78e236
Make `locale required in sphinx.util.i18n.format_date()` ( #11366 )
2023-04-27 01:30:40 +01:00
Adam Turner
973e8fb5cf
Remove the deprecated `sphinx.ext.napoleon.iterators` module ( #11364 )
2023-04-27 01:27:07 +01:00
Adam Turner
2a9e805206
Remove the deprecated Setuptools integration ( #11363 )
2023-04-27 01:22:04 +01:00
Adam Turner
720f89d1d6
Update test for Alabaster version tuple
2023-04-26 17:24:02 +01:00
Adam Turner
d2aa91f63c
Revert the default type of `nitpick_ignore[_regex] to list`
2023-04-25 11:31:57 +01:00
James Addison
59de8d5202
Revert "Support and prefer `.jinja to _t` for static templates ( #11165 )" ( #11329 )
...
This reverts commit 5d13215b58
2023-04-23 19:06:44 +01:00
Adam Turner
aee3c0ab75
Partially revert "Disable localisation when SOURCE_DATE_EPOCH is set ( #10949 )" ( #11343 )
...
This keeps some of the added tests, and avoids a full revert of ``sphinx.locale``.
2023-04-21 19:04:26 +01:00
Martin Liška
186d596f33
Use `overwrite_file context manager in test_ext_autodoc_configs` ( #11320 )
...
The tests modify source files (e.g. index.rst) that are not restored
and thus another test could read an altered source file, it leading
to unexpected test results.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-04-21 02:44:11 +01:00
Martin Liška
77483f2824
Add missing test decorator for `test_util_inspect` ( #11321 )
2023-04-21 02:22:10 +01:00
James Addison
d8f15c7361
Increase timeout threshold for `linkcheck` tests ( #11326 )
2023-04-21 02:08:14 +01:00
Bénédikt Tran
e2f66cea49
Update CHANGES for PR #11333
2023-04-18 12:13:20 +02:00
Bénédikt Tran
61576516d4
Fix duplicated labels in TeX output ( #11093 )
2023-04-17 12:07:32 +02:00
Martin Liska
b6e6805f80
test_build_latex: move output to a separate output dir
...
Related: #11285
Co-authored-by: Jean-François B <2589111+jfbu@users.noreply.github.com>
2023-04-13 06:15:50 +02:00
Jean-François B
b95fc0e88b
Use leaner TeX syntax (follow-up to #11319 )
...
Because it is cool. And avoids overhead. Matter of principle.
2023-04-11 20:41:58 +02:00
Jean-François B
509cc4533c
LaTeX: get aligned longtable obey current list indent
...
Fix #11268 .
Thanks to @picnixz.
2023-04-11 20:32:31 +02:00
James Addison
5d13215b58
Support and prefer `.jinja to _t` for static templates ( #11165 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-04-07 18:07:15 +01:00
James Addison
f82c3c9912
Disable localisation when `SOURCE_DATE_EPOCH` is set ( #10949 )
...
This commit disables Sphinx's localisation features when reproducible
builds are requested, as determined by a non-empty SOURCE_DATE_EPOCH_
environment variable.
The `Reproducible Builds`_ project aims to provide confidence to
consumers of packaged software that the artefacts they're downloading
and installing have not been altered by the environment they were
built in, and can be replicated at a later date if required.
Builds of localised documentation using Sphinx currently account for
a large category of reproducible build testing failures, because the
builders intentionally use varying environment locales at build-time.
This can affect the contents of the ``objects.inv`` file.
During investigation, it turned out that many ``gettext``-localised
values (particularly in Python modules under ``sphinx.domains``) were
being translated at module-load-time and would not subsequently be
re-localised.
This creates two unusual effects:
1. Attempting to write a test case to build the same application in
two different languages was not initially possible, as the
first-loaded translation catalogue (as found in the
``sphinx.locale.translators`` global variable) would remain in-use
for subsequent application builds under different locales.
2. Localisation of strings could vary depending on whether the
relevant modules were loaded before or after the resource
catalogues were populated.
We fix this by performing all translations lazily so that module
imports can occur in any order and localisation of inventory entries
should occur only when translations of those items are requested.
Localisation can then be disabled by configuring the ``gettext``
language to the ISO-639-3 'undetermined' code (``'und'``), as this
should not have an associated translation catalogue. We also want to
prevent ``gettext`` from attempting to determine the host's locale
from environment variables (including ``LANGUAGE``).
.. _SOURCE_DATE_EPOCH: https://reproducible-builds.org/docs/source-date-epoch/
.. _Reproducible Builds: https://www.reproducible-builds.org/
2023-04-07 17:49:36 +01:00
Jens Hedegaard Nielsen
3edae68904
autosummary: Support documenting inherited attributes ( #10691 )
...
The current implementation of ``import_ivar_by_name`` filters
attributes if the name of the object that the attribute belongs to
does not match the object being documented. However, for inherited
attributes this is not the case. Filtering only on the attribute name
seems to resolve the issue. It is not clear to me if there are any
unwanted sideeffects of this and we should filter on the list of
qualnames for the object and all its super classes (if any).
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-04-06 23:33:43 +01:00
Adam Turner
7ecf037280
Enable 'nit-picky mode' for Sphinx's documentation
...
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
2023-04-06 23:11:39 +01:00
picnixz
aba392d87f
Support type comments in `PropertyDocumenter` ( #11298 )
2023-04-06 22:56:17 +01:00
