Commit Graph

16272 Commits

Author SHA1 Message Date
Takeshi KOMIYA
8ed1e706cc
Merge pull request #8527 from tk0miya/8111_pretty_change
refactor: pretty change for isproperty()
2020-12-14 01:33:01 +09:00
Takeshi KOMIYA
399210c807
Merge pull request #8533 from tk0miya/deprecate_no_docstring
refactor: Deprecate `no_docstring` argument for Documenter.add_content()
2020-12-14 01:32:42 +09:00
Takeshi KOMIYA
368c223f08
Merge pull request #8535 from nedbat/nedbat/more-about-intersphinx
Describe the intersphinx mapping a bit more
2020-12-13 22:41:25 +09:00
Ned Batchelder
bac6ab8d0c Describe the intersphinx mapping a bit more 2020-12-13 08:04:55 -05:00
Takeshi KOMIYA
3638a9e4d1 refactor: Deprecate no_docstring argument for Documenter.add_content()
This deprecates `no_docstring` argument for Documenter.add_content().
After this change, please use Documenter.get_doc() to control (suppress)
the content of the python object.
2020-12-13 02:11:53 +09:00
Jakob Lykke Andersen
c777a90816
Merge pull request #8530 from jakobandersen/bnavigator-fix-AliasNode-copy
C, fix AliasNode.copy
2020-12-12 17:47:08 +01:00
Jakob Lykke Andersen
43113594aa Update CHANGES 2020-12-12 17:27:47 +01:00
Jakob Lykke Andersen
b7c7adfd18 C++, typing on AliasNode.copy 2020-12-12 17:26:27 +01:00
Ben Greiner
e35639299d Fix mypy type error 2020-12-12 17:24:25 +01:00
Ben Greiner
61556e3410 Fix AliasNode.copy() 2020-12-12 17:24:25 +01:00
Takeshi KOMIYA
8823d1c528
Merge pull request #8528 from jdufresne/drop-workaround
Drop outdated workaround for distutils' Command._ensure_stringlike()
2020-12-13 00:11:15 +09:00
Takeshi KOMIYA
d5e13324e8
Merge pull request #8529 from jdufresne/dup-test
Remove duplicate test in test_ext_autodoc.py
2020-12-12 23:55:10 +09:00
Jon Dufresne
850512090a Remove duplicate test in test_ext_autodoc.py
Duplicate since c6bd84a614.
2020-12-12 06:28:23 -08:00
Jon Dufresne
0938bdb2a8 Drop outdated workaround for distutils' Command._ensure_stringlike()
The issue applied to Python 2 only. The current override is identical to
the CPython implementation:

4b8cdfcb22/Lib/distutils/cmd.py (L207-L215)
2020-12-12 06:17:59 -08:00
Takeshi KOMIYA
e15f7a1f02 refactor: pretty change for isproperty()
It is more readable to use `>=` to compare versions.
2020-12-12 18:54:53 +09:00
Takeshi KOMIYA
8faa8ba7ab Update CHANGES for PR #8523 2020-12-12 15:16:51 +09:00
Takeshi KOMIYA
9d96c07133
Merge pull request #8523 from ArtyomKaltovich/fix_bool_issue
fix #8522: sphinx could lead to `__bool__` method call, what can lead to side effect or direct failure in case it generate an error bug
2020-12-12 15:15:57 +09:00
ArtyomKaltovich
2276351458
Merge branch '3.x' into fix_bool_issue 2020-12-08 13:07:34 -05:00
Artyom Kaltovich
964b9824d7 fix CHANGES 2020-12-08 21:04:53 +03:00
Takeshi KOMIYA
e35770f023 Update CHANGES for PR #8519 2020-12-09 02:00:09 +09:00
Toni Ruža
a8f5341d88 Fold long line 2020-12-09 01:59:13 +09:00
Toni Ruža
6fc83981b3 Prevent page brake in the middle of a seealso 2020-12-09 01:59:06 +09:00
Artyom Kaltovich
5be21b4baa fix typo 2020-12-07 14:40:12 +03:00
Artyom Kaltovich
612479dcf0 fix bullet list 2020-12-07 14:38:58 +03:00
Artyom Kaltovich
6fdbce933b fix_8522 2020-12-07 14:31:10 +03:00
Takeshi KOMIYA
9cf2826491
Merge pull request #8506 from tk0miya/8352_option_startswith_bracket
Fix #8352: std domain: Failed to parse an option that starts with bracket
2020-11-29 23:58:18 +09:00
Takeshi KOMIYA
cafb8bfe92
Merge pull request #8507 from tk0miya/refactor_html_events_registration
refactor: Register events for HTML builders in the HTML builder module
2020-11-29 23:57:47 +09:00
Takeshi KOMIYA
aa84eea08b
Merge pull request #8504 from tk0miya/deprecate_GenericAliasDocumenter
Fix #8503: autoattribute could not create document for a GenericAlias
2020-11-29 12:50:19 +09:00
Takeshi KOMIYA
bb63f03034 Fix #8503: autoattribute could not create document for a GenericAlias 2020-11-29 12:24:10 +09:00
Takeshi KOMIYA
c15c61ed64
Merge pull request #8505 from tk0miya/8501_extract_summary_el_at
Fix #8501: autosummary: summary extraction splits text after "el at."
2020-11-29 11:48:55 +09:00
Takeshi KOMIYA
233cdc1063
Merge pull request #8502 from tk0miya/refactor_autodoc_depraction
refactor: autodoc: Move deprecated documenters to autodoc.deprecated package
2020-11-29 11:48:14 +09:00
Takeshi KOMIYA
aa1978fe20
Merge pull request #8500 from tk0miya/refactor_UninitializedGlobalVariableMixin
refactor: autodoc: Add UninitializedGlobalVariableMixin
2020-11-29 11:47:24 +09:00
Takeshi KOMIYA
6a88e64fd0 refactor: Register events for HTML builders in the HTML builder module 2020-11-29 02:31:28 +09:00
Takeshi KOMIYA
bae7ab9c9d Update CHANGES for PR #8291 2020-11-29 02:30:42 +09:00
Takeshi KOMIYA
6d24579f40 Fix #8352: std domain: Failed to parse an option that starts with bracket 2020-11-29 02:22:40 +09:00
Takeshi KOMIYA
e4bd3bd3dd Update CHANGES for PR #8494 2020-11-28 22:56:12 +09:00
Takeshi KOMIYA
3f3358b38f
Merge pull request #8494 from timoludwig/alias-of-builtin
Use restify() to reference alias attributes in autodoc
2020-11-28 22:55:27 +09:00
Timo Ludwig
ccfd98dc07
Fix #8493: Use restify() in autodoc to reference alias attributes 2020-11-28 12:12:02 +01:00
Takeshi KOMIYA
da4c69c624
Merge pull request #8291 from QuentinSoubeyran/8285_napoleon_google_style_use_annotations
Fix #8285: napoleon can use PEP526 annotations
2020-11-28 18:11:30 +09:00
Takeshi KOMIYA
adb8f97156 refactor: autodoc: Move deprecated documenters to autodoc.deprecated package 2020-11-28 17:01:06 +09:00
Takeshi KOMIYA
65ca7aa0c9 Fix #8501: autosummary: summary extraction splits text after "el at."
Add "el at." to the list of abbreviations.
2020-11-28 11:41:06 +09:00
Takeshi KOMIYA
00cd12e7e2
Merge pull request #8495 from QuentinSoubeyran/fix-8491
fix for #8491
2020-11-28 10:12:00 +09:00
Takeshi KOMIYA
beb2835849
Merge pull request #8499 from jdufresne/monkeypatch
Replace modify_env() with pytest monkeypatch.setenv()
2020-11-28 09:22:44 +09:00
Jon Dufresne
c1437d5f79 Replace modify_env() with pytest monkeypatch.setenv()
The same test utility function is built into pytest. Can avoid the
duplication.

https://docs.pytest.org/en/latest/monkeypatch.html#monkeypatching-environment-variables
2020-11-27 14:10:36 -08:00
Takeshi KOMIYA
3c86eb355e refactor: autodoc: Add UninitializedGlobalVariableMixin
To make DataDocumenter simple, this divide uninitialized global variable
feature from DataDocumenter as UninitializedGlobalVariableMixin.
2020-11-27 23:39:24 +09:00
Takeshi KOMIYA
e0704fb32e
Merge pull request #8496 from francoisfreitag/unsetenv
Unset env variables in tests by del os.environ
2020-11-27 22:04:54 +09:00
François Freitag
236afac7fd
Unset env variables in tests by del os.environ
The `unsetenv()` operation does not update `os.environ`.
https://docs.python.org/3/library/os.html#os.unsetenv
2020-11-26 21:12:28 +01:00
Quentin Soubeyran
5f2734080e fix for #8491 2020-11-26 20:19:37 +01:00
Takeshi KOMIYA
e6e23aa45b
Merge pull request #8488 from tk0miya/deprecate_InstanceAttributeDecorator
refactor: Deprecate InstanceAttributeDocumenter
2020-11-26 20:13:03 +09:00
Takeshi KOMIYA
79491e1116
Merge pull request #8490 from tk0miya/pycode_slow
Fix pycode becomes slow
2020-11-26 20:11:52 +09:00