Takeshi KOMIYA
10dd5a0e43
Fix #10421 : autodoc_preserve_defaults doesn't work on class methods
2022-05-08 22:59:14 +09:00
Takeshi KOMIYA
f5e4e70817
Fix #10266 : autodoc_preserve_defaults crashes on kwonlyargs w/o defaults
2022-04-02 16:55:48 +09:00
Takeshi KOMIYA
aa1bc83c2a
Merge branch '4.x'
2022-03-19 22:58:15 +09:00
Adam Turner
5775912455
Collapse single line docstrings
2022-02-20 03:13:45 +00:00
Adam Turner
6bb7b891a1
Remove copyright and licence fields
2022-02-20 03:06:23 +00:00
Adam Turner
5694e0ce60
Fix module docstring indentation
2022-02-20 00:35:13 +00:00
Adam Turner
4f5a3269a6
Fix module docstring first line
2022-02-20 00:11:08 +00:00
Adam Turner
6b8bccec59
Remove module titles in docstrings
2022-02-19 23:17:29 +00:00
Takeshi KOMIYA
616f112e6a
autodoc: The default of autodoc_typehints_format becomes to 'smart'
...
The default value of autodoc_typehints_format configuration is changed
to `'smart'`. It will suppress the leading module names of typehints
(ex. `io.StringIO` -> `StringIO`).
refs: #9075
2022-01-02 17:35:19 +09:00
Takeshi KOMIYA
f38bd8e952
Merge branch '4.3.x' into 4.x
2022-01-01 20:02:10 +09:00
Takeshi KOMIYA
b84771dcd2
A happy new year!
2022-01-01 18:45:03 +09:00
Takeshi KOMIYA
bdbad40f57
Fix #9194 : autodoc: Prepend the "typing" module name on the signature
...
To create hyperlinks to container types automatically, this prepends the
module names for the types under "typing" module.
2021-12-26 01:04:40 +09:00
Takeshi KOMIYA
b8844eb339
Fix #9781 : autodoc_preserve_defaults does not support hexadecimal
2021-10-31 01:11:56 +09:00
Christian Clauss
86583c578c
Fix typos discovered by codespell
2021-09-08 02:15:25 +02:00
Takeshi KOMIYA
1ea11b1e48
Fix #759 : autodoc: Add sphinx.ext.autodoc.preserve_defaults extension
...
Add a new extension `sphinx.ext.autodoc.preserve_defaults`.
It preserves the default argument values of function signatures in source code
and keep them not evaluated for readability. This is an experimental
extension and it will be integrated into autodoc core in Sphinx-4.0.
2021-03-06 18:48:18 +09:00
