Matthias Geier
76497988cb
Return `parallel_read_safe` in the autodoc_intenum tutorial ( #12288 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-04-26 01:49:04 +01:00
Chris Sewell
3bedde26a9
🔧 Ruff format python files within docs folder ( #12139 )
...
Remove `docs` files from the `exclude` list, and also add the `preview = false` format config, which is shown to reduce diffs to the current code base
2024-03-19 15:23:57 +01:00
Adam Turner
9bcf1d8bb3
Fix TCH001 (move application import into a type-checking block)
2023-08-14 00:18:13 +01:00
Adam Turner
36012b7d96
Fix TCH002 (move third-party import into a type-checking block)
2023-08-13 22:50:03 +01:00
Adam Turner
c8f4a03dac
Fix COM812
2023-02-18 01:58:05 +00:00
Adam Turner
14a9289d78
Use PEP 604 types
2023-01-01 20:48:39 +00:00
Adam Turner
f4c8a0a68e
Insert `from __future__ import annotations`
2023-01-01 20:48:37 +00:00
Jouke Witteveen
e200e7b7c1
doc: Improve autodoc extension example
...
Enumerations can have aliases, which should be documented as well.
2021-12-06 12:31:09 +01:00
Jouke Witteveen
bc849e2170
doc: Fix autodoc extension example
...
`directivetype` is set to mimic `ClassDocumenter`. Reflect that.
`isinstance` would work on the enum members, but that is not what we want here.
`issubclass` raises a TypeError when called on objects that are not classes.
2021-12-02 16:50:09 +01:00
igo95862
1ac05a2a83
doc: Create autodoc extension tutorial
2021-03-09 17:56:46 +03:00
