Takeshi KOMIYA
78d407cf83
Update CHANGES for PR #8404
2020-11-14 18:55:25 +09:00
François Freitag
683635f5b4
linkcheck: Remove call to is_ssl_error()
...
This method always returns False, it is dead code. The exception
checking stopped working because Requests library wraps SSL errors in a
`requests.exceptions.SSLError` and no longer throws an
`urllib3.exceptions.SSLError`. The first argument to that exception is
an `urllib3.exceptions.MaxRetryError`.
2020-11-12 19:58:04 +01:00
Takeshi KOMIYA
a3af1e860b
Merge branch '3.3.x' into 3.x
2020-11-12 23:40:41 +09:00
Takeshi KOMIYA
97c5f63b62
Bump version
2020-11-12 23:23:20 +09:00
Takeshi KOMIYA
c09795c194
Bump to 3.3.1 final
2020-11-12 23:21:14 +09:00
Takeshi KOMIYA
953a5ec898
Fix #8350 : autosummary_mock_imports causes slow down builds
...
The mock objects set up via `autosummary_mock_imports` causes slow down
of autosummary stub generation because AttributeDocumenter falls into
infinite recursion call to unwrap decorators of mocked objects.
To avoid the trouble, this blocks unwrapping decorators of mocked
objects.
2020-11-12 01:55:42 +09:00
Takeshi KOMIYA
4664814ed2
Merge pull request #8397 from tk0miya/apply_get_type_hints
...
autodoc: Add Optional[t] to annotation of function and method
2020-11-10 22:31:38 +09:00
Takeshi KOMIYA
de2d2cc6ac
Update CHANGES for PR #8399
2020-11-10 22:20:52 +09:00
Takeshi KOMIYA
9154bc5456
Merge branch '3.3.x' into 3.x
2020-11-10 20:40:55 +09:00
Takeshi KOMIYA
e2836c4361
Update CHANGES for PR #8231
2020-11-10 20:40:44 +09:00
Takeshi KOMIYA
6d1cafe7bd
autodoc: Add Optional[t] to annotation of function and method
...
As typing.get_type_hints() doing, this adds Optional[t] to type
annotations if a default value equal to None is set.
Note: this is default behavior of inspect.signature() since Python 3.10.
2020-11-10 02:41:58 +09:00
Takeshi KOMIYA
51da043791
refactor: Add `Documenter.config` as a shortcut to access the config object
2020-11-10 00:43:23 +09:00
Takeshi KOMIYA
ed5af2461f
Merge branch '3.3.x' into 7727_autosummary_PycodeError
2020-11-10 00:31:44 +09:00
Takeshi KOMIYA
e2bf9166da
Fix #8219 : autodoc: Parameters for generic base class are not shown
2020-11-09 02:34:49 +09:00
Takeshi KOMIYA
787444ff18
Fix #7727 : autosummary raises PycodeError for namespace python package
2020-11-09 02:06:14 +09:00
Takeshi KOMIYA
e3eec9f0e1
Fix #8372 : autodoc: autoclass directive became slower than Sphinx-3.2
...
* The result of ModuleAnalyzer.parse() is not cached
* autodoc tries to search overloaded constructor methods to the root
class even if a definition found
2020-11-08 23:23:32 +09:00
Takeshi KOMIYA
896ecc34d7
Merge branch '3.x' into 8119_control_appearance_of_member_not_in_module.__all__
2020-11-08 17:40:13 +09:00
Takeshi KOMIYA
1955a08378
Merge branch '3.x' into 8105_incorrect_class_constructor
2020-11-08 12:34:09 +09:00
Jakob Lykke Andersen
1193d83166
Update CHANGES
2020-11-07 10:40:30 +01:00
Takeshi KOMIYA
6d05b1aeb3
Fix #8105 : autodoc: the signature of decorated class is incorrect
...
In #7651 , autodoc stops to undecorate the functions on getting the
signature from the callables. But some kinds of decorators conceals
the correct signature because they pass through their arguments via
`(*args, **kwargs)`.
This restarts to undecorate the functions again as before #7651 .
2020-11-05 01:57:40 +09:00
Takeshi KOMIYA
e1e0106aa4
Merge branch '3.x' into 4606_incorrect_location_of_docstring
2020-11-05 01:54:23 +09:00
Takeshi KOMIYA
0cf1632edf
Update CHANGES for PR #8355
2020-11-05 01:53:42 +09:00
Takeshi KOMIYA
2da6de6721
Fix #4606 : autodoc: the location of the warning is incorrect for inherited method
2020-11-04 01:35:02 +09:00
Takeshi KOMIYA
9f1c89dd9d
Update CHANGES for PR #8355
2020-11-03 11:39:44 +09:00
Takeshi KOMIYA
7065dc0157
Merge branch '3.x' into 7613_class__signature__
2020-11-03 11:39:23 +09:00
Takeshi KOMIYA
9f0f34cbda
Close #8119 : autodoc: Control visibility of module member not in __all__
...
This allows `autodoc-skip-member` handlers to determine whether a member
not included in `__all__` attribute of the module should be documented or
not.
2020-11-03 02:28:32 +09:00
Takeshi KOMIYA
0e98e9b1a8
Fix #6914 : Emit a detailed warning when failed to resolve :ref:
...
To be clear the ambiguous warning for missing-reference :ref:,
this separates the warning to missing-label and missing-caption.
To emit a warning dynamically, this also adds a new event:
`warn-missing-reference` to customize warning messages via event
handlers.
2020-11-03 02:27:43 +09:00
Takeshi KOMIYA
487b8436c6
Bump version
2020-11-02 22:24:25 +09:00
Takeshi KOMIYA
17299d1392
Bump version
2020-11-02 22:22:21 +09:00
Takeshi KOMIYA
24848f5a6a
Bump to 3.3.0 final
2020-11-02 22:18:45 +09:00
Takeshi KOMIYA
7071631d2b
Merge CHANGES of 3.2.2 into 3.0.0
2020-11-02 22:17:10 +09:00
Takeshi KOMIYA
b415b25c09
Merge branch '3.2.x' into 3.x
2020-11-01 20:31:49 +09:00
Takeshi KOMIYA
9a44e45277
Fix #7613 : autodoc: autodoc does not respect __signature__ of the class
2020-11-01 18:27:16 +09:00
Takeshi KOMIYA
27b1a693d0
Update CHANGES for PR #8183
2020-11-01 12:28:04 +09:00
Takeshi KOMIYA
73f538da0f
Update CHANGES for PR #8050
2020-10-30 02:00:53 +09:00
Takeshi KOMIYA
751b7a0251
Update CHANGES for PR #8051
2020-10-30 00:50:55 +09:00
Takeshi KOMIYA
871f43f778
Merge branch '3.x' into 7785_autodoc_typehints_none_for_overloads
2020-10-28 02:13:49 +09:00
Takeshi KOMIYA
2c2335bbb8
Update CHANGES for PR #8304
2020-10-28 00:04:10 +09:00
Takeshi KOMIYA
9fc5c37817
Update CHANGES for PR #8316
2020-10-28 00:02:14 +09:00
Takeshi KOMIYA
0ddfb16666
Update CHANGES for PR #8333
2020-10-28 00:01:45 +09:00
Takeshi KOMIYA
ca579303e7
Merge pull request #8340 from tk0miya/8298_quickstart_no-sep_option
...
Fix #8298 : sphinx-quickstart: Add `sphinx-quickstart --no-sep` option
2020-10-27 23:55:40 +09:00
Takeshi KOMIYA
d17563987a
Update CHANGES for PR #8343
2020-10-27 23:55:12 +09:00
Takeshi KOMIYA
b453be75c9
Fix #8298 : sphinx-quickstart: Add :option:sphinx-quickstart --no-sep option
2020-10-26 01:12:36 +09:00
Takeshi KOMIYA
f2a31185a6
Update CHANGES for PR #8216
2020-10-26 00:59:25 +09:00
Takeshi KOMIYA
ae2e48de15
Merge pull request #8216 from glikely/fix-oneside-latex
...
Fix 'oneside' latex build warnings
2020-10-26 00:58:18 +09:00
Takeshi KOMIYA
ad7c09ef10
Update CHANGES for PR #8338
2020-10-25 18:59:33 +09:00
Takeshi KOMIYA
746842f4fc
Update CHANGES for PR #8323
2020-10-25 18:52:45 +09:00
Takeshi KOMIYA
eb3d9355f5
Merge pull request #8332 from sphinx-doc/8321_linkcheck_tel_links
...
Fix #8321 : linkcheck: ``tel:`` schema hyperlinks are detected as errors
2020-10-25 18:48:50 +09:00
Matthias Geier
38a6838119
Add CHANGES for #8320
2020-10-24 15:12:58 +02:00
Takeshi KOMIYA
cc97a07640
Fix #7785 : autodoc_typehints=none does not effect to overloads
2020-10-24 20:54:56 +09:00
