Commit Graph

21033 Commits

Author SHA1 Message Date
dependabot[bot]
3da0b7a403
Bump ruff from 0.3.2 to 0.3.3 (#12123)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-19 14:00:52 +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
Bénédikt Tran
b9b0ad856a
[lint] ignore `venv` directory (#12138) 2024-03-19 11:07:08 +01:00
Chris Sewell
d8cf71cbde
🔧 Setup ruff format (initially excluding all files) (#12136)
Co-authored-by: danieleades <33452915+danieleades@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-19 10:27:41 +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
Chris Sewell
3f3d3d8517
🔧 Add flake8 to make style-check (#12137) 2024-03-19 10:07:41 +01:00
Chris Sewell
aaecc9376d
🔧 Remove unused regexes (#12132)
These appear to have been copied to class variables at some point, but then not removed as global variables
2024-03-19 09:36:22 +01:00
Chris Sewell
a27f156e31
🔧 Add check rule to Makefile (#12135)
To run all linting/type-checking, just for dev ease

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-19 09:34:34 +01:00
dependabot[bot]
95d710e78f
Bump softprops/action-gh-release from 1 to 2 (#12059)
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
2024-03-19 03:03:48 +01:00
dependabot[bot]
63c53c412f
Bump peter-evans/create-pull-request from 5 to 6 (#11947)
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
2024-03-19 02:54:26 +01:00
dependabot[bot]
2f6156f605
🔧 Bump codecov/codecov-action from 3 to 4 (#11948)
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
2024-03-19 02:45:53 +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
Brad King
a9383a026e
[search] order non-main index entries after other results (#11696) 2024-03-18 17:37:59 +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
Bénédikt Tran
b2069fb64f
[lint] update Makefile and lint doc (#12117) 2024-03-17 14:45:56 +01:00
danieleades
4f7318767c
[lint] extend FURB lints (#12088) 2024-03-17 12:06:39 +01:00
Johannes Altmanninger
22968d29f5
[manpage] emit OSC 8 hyperlinks via groff (#12108)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-17 10:55:04 +01:00
James Addison
e2ad48a521
[search] Update copyright year in the searchfield.html header. (#12110)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-17 02:27:15 +01:00
Bénédikt Tran
6b45608f1d
[lint] remove files from whitelist that are currently fine (#12113) 2024-03-16 19:09:28 +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
6aaeee206b
[search] constraint retrieval for anchored search result summary (#12105)
This is a post-merge adjustments for #11944.
2024-03-16 11:34:59 +01:00
Bénédikt Tran
16748aef2d
[tests] update the `pytest.mark.sphinx` signature description (#12104) 2024-03-16 10:56:30 +01:00
Bénédikt Tran
4ca034bbba
[tests] start fixing the current plugin [part 1] (#12089) 2024-03-16 10:38:12 +01:00
James Addison
6af611ed85
[javascript] Update vulnerable dependencies using 'npm audit fix'. (#12101) 2024-03-15 17:58:24 +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
danieleades
768cf5e7ac
[lint] run mypy on the utils/ directory (#12090)
Co-authored-by: daniel.eades <daniel.eades@seebyte.com>
2024-03-15 10:31:32 +01:00
mkay
7bd9c59435
[htmlhelp] do not add checksums to css files if building using the htmlhelp builder (#11894)
Co-authored-by: Jan-Hendrik Garber <jan-hendrik.garber@avanquest.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-03-15 09:27:23 +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
danieleades
23dd754f63
[lint] ruff simplify config (#12086)
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 12:33:17 +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
d6f49f9c09
[lint] simplify lint config for flake8-annotations (#12073)
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:37:15 +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
d4c739cdd1
[lint] add PERF401 lint (#12070)
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:16:36 +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
Bénédikt Tran
f3087e8405
[env] fix pickled doctrees cache (#11939) 2024-03-14 10:22:51 +01:00
danieleades
12d523efdc
[deps] bump mypy version (#12066)
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:06:27 +01:00
danieleades
3190c3fcf1
[github] update dependabot config (#12071) 2024-03-14 09:55:07 +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
Alexandre Franke
1281b158b4
Fix typos in usage/configuration.rst (#12024) 2024-03-07 20:50:46 +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
Bénédikt Tran
7f582a56ba
[doctest] fix a resources leak for the `doctest` builder (#12044) 2024-03-03 12:14:42 +01:00