Commit Graph

17731 Commits

Author SHA1 Message Date
Takeshi KOMIYA
d69c35b1a4 Fix #9175: autodoc: Special member is not documented in the module
The special members are not treated as "attributes".  So they're not
handled by DataDocumenter.  This moves the detection to the earlier
step of filter_members().
2021-05-08 17:33:33 +09:00
Takeshi KOMIYA
f47bf1471d
Merge pull request #9178 from sphinx-doc/dependabot/npm_and_yarn/lodash-4.17.21
Bump lodash from 4.17.19 to 4.17.21
2021-05-08 00:46:39 +09:00
dependabot[bot]
9c1a58d5e1
Bump lodash from 4.17.19 to 4.17.21
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.19 to 4.17.21.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.19...4.17.21)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-07 13:34:26 +00:00
Takeshi KOMIYA
512743525c Update CHANGES for PR #9131 2021-05-06 00:23:37 +09:00
Takeshi KOMIYA
829de019c5
Merge pull request #9162 from tk0miya/jinja2-3.0
Support jinja2-3.0
2021-05-06 00:02:24 +09:00
Takeshi KOMIYA
d82c8a7890
Merge pull request #9131 from RuRo/feature/glob-nitpick-ignore
Ignore nitpick warnings with regular expressions using `nitpick_ignore_regex`
2021-05-05 23:43:46 +09:00
Takeshi KOMIYA
d006c66e23 Update CHANGES for PR #9146 2021-05-05 22:28:57 +09:00
Takeshi KOMIYA
1f860cb77e
Merge pull request #9146 from pbudzyns/autosummary-iattr-include
Autosummary to include instance attributes
2021-05-05 22:27:28 +09:00
Takeshi KOMIYA
77da494173
Merge pull request #9153 from tk0miya/9082_python3.10.0a7
Revert "test: Disable testing with python3.10"
2021-05-05 22:22:30 +09:00
Takeshi KOMIYA
531a5ae9ef test: Adjust type annotataions in python 3.10.0b1 2021-05-05 22:11:41 +09:00
Takeshi KOMIYA
43434a086c
Merge pull request #9164 from tk0miya/refactor_Optional
refactor: Add Optional to type annotations
2021-05-04 21:04:16 +09:00
Takeshi KOMIYA
50d027a036 Update CHANGES for PR #9167 2021-05-04 20:24:30 +09:00
Takeshi KOMIYA
a0d60360f4
Merge pull request #9167 from bonartm/fix_css_specific_page
html: fix missing reverting when adding css files to specific page
2021-05-04 20:18:59 +09:00
Malte Bonart
a7c5a3a88b fix missing underscore
fix missing reverting when adding css files via app.add_css_file in a html-page-context event
2021-05-04 08:42:01 +02:00
Takeshi KOMIYA
85f58874ec Support jinja2-3.0
Since jinja2-3.0, some utility functions like contextfunction and
environmentfilter are renamed to new name.  This follows the updates to
support jinja2-3.0 or above.
2021-05-04 14:37:41 +09:00
Takeshi KOMIYA
930bf6c327 refactor: Add Optional to type annotations 2021-05-03 22:41:19 +09:00
Takeshi KOMIYA
f31af4b815 Merge branch '4.0.x' into 4.x 2021-05-03 22:31:51 +09:00
Takeshi KOMIYA
110fe1797c
Merge pull request #9159 from tk0miya/8588_nested_autodoc_type_aliases
Fix #8588: autodoc_type_aliases does not support dotted name
2021-05-03 22:30:01 +09:00
Takeshi KOMIYA
38758dbcce
Merge pull request #9158 from tk0miya/8597_metadata_only_docstring
Fix #8597: autodoc: metadata only docstring is treated as undocumented
2021-05-03 22:26:11 +09:00
Takeshi KOMIYA
30efa3d947
Merge branch '4.x' into 8597_metadata_only_docstring 2021-05-03 22:11:10 +09:00
Takeshi KOMIYA
cb7b41f151
Merge pull request #9157 from tk0miya/8872_stacked_singledispatch
Fix #8872: autodoc: stacked singledispatches are wrongly rendered
2021-05-03 22:10:41 +09:00
Takeshi KOMIYA
caa6579dbd Fix #8872: autodoc: stacked singledispatches are wrongly rendered
When multiple singledispatch decorators are stacked, the first typehints
are copied to the subsequent definitions unexpectedly.

Now autodoc generates a dummy function not to affect typehints to
subsequent functions.
2021-05-03 21:51:19 +09:00
Takeshi KOMIYA
cfb9183715 Update dependency: jinja2 < 3.0 and MarkupSafe < 2.0
Jinja2 and MarkupSafe have a plan to major release in the near future.
And it will introduce some changes for its APIs.  To lessen the noise
of the DeprecationWarnings, this pins the versions to current stable
release.
2021-05-03 21:48:13 +09:00
Takeshi KOMIYA
05abdad749
Merge pull request #9161 from tk0miya/pin_jinja2
Update dependency: jinja2 < 3.0 and MarkupSafe < 2.0
2021-05-03 21:47:27 +09:00
Takeshi KOMIYA
53c6353714
Merge pull request #9163 from tk0miya/extlinks_warning
Fix test: deprecation warning for extlinks
2021-05-03 21:46:55 +09:00
Takeshi KOMIYA
8d54010675 Fix test: deprecation warning for extlinks 2021-05-03 18:52:19 +09:00
Takeshi KOMIYA
28ab5f233c Close #8588: autodoc: autodoc_type_aliases supports dotted name
It allows users to define an alias for a class with module name
like `foo.bar.BazClass`.
2021-05-03 18:47:47 +09:00
Takeshi KOMIYA
7acfc7826f Update dependency: jinja2 < 3.0 and MarkupSafe < 2.0
Jinja2 and MarkupSafe have a plan to major release in the near future.
And it will introduce some changes for its APIs.  To lessen the noise
of the DeprecationWarnings, this pins the versions to current stable
release.
2021-05-03 13:56:23 +09:00
Takeshi KOMIYA
469def56b6 Fix #8597: autodoc: metadata only docstring is treated as undocumented
The metadata in docstring is invisible content. Therefore docstring
having only metadata should be treated as undocumented.
2021-05-02 23:17:58 +09:00
pbudzyns
abbd005612 revert get members for module 2021-05-02 13:55:16 +02:00
ruro
afa80dfe03
add tests for nitpick_ignore_regex 2021-05-02 14:54:00 +03:00
ruro
0aea6d318c
add tests for regular nitpick_ignore 2021-05-02 14:53:46 +03:00
ruro
bf2e69ad13
add nitpicky-warnings test root 2021-05-02 14:53:01 +03:00
Takeshi KOMIYA
b237e78f9c
Merge pull request #9154 from tk0miya/8107_class-doc-from
Close #8107: autodoc: Add class-doc-from option to autoclass directive
2021-05-02 20:31:51 +09:00
ruro
104d0a3f69
describe nitpick_ignore_regex in docs 2021-05-02 13:31:13 +03:00
ruro
00bc3465b3
implement nitpick_ignore_regex 2021-05-02 13:31:13 +03:00
Takeshi KOMIYA
30237c004d Update CHANGES for PR #9120 2021-05-02 18:32:02 +09:00
Takeshi KOMIYA
11d3a45ba2
Merge pull request #9120 from V0lantis/feature/selecting_usage
Feature:
2021-05-02 18:25:09 +09:00
Takeshi KOMIYA
d8a9f243e2 Close #8107: autodoc: Add class-doc-from option to autoclass directive
Add `class-doc-from` option to the `autoclass` directive to control
the content of the specific class.  It takes `class`, `init`, and `both`
like `autoclass_content`.
2021-05-01 14:53:06 +09:00
Takeshi KOMIYA
d656acaba3
Merge pull request #9144 from tk0miya/refactor_linkcheck2
refactor: linkcheck: Call write_linkstat() at the top of process_result()
2021-05-01 01:32:43 +09:00
Takeshi KOMIYA
55b55fd45e
Merge pull request #9150 from webknjaz/patch-1
Mention that aiohttp uses its own custom theme
2021-05-01 01:31:24 +09:00
Takeshi KOMIYA
7bc14b596e
Merge pull request #9143 from tk0miya/refactor_linkcheck
refactor: linkcheck: Use attributes of CheckResult in process_result()
2021-05-01 01:30:56 +09:00
Takeshi KOMIYA
35dda449c0 Revert "test: Disable testing with python3.10"
This reverts commit 8602e64214.
2021-05-01 01:17:56 +09:00
Sviatoslav Sydorenko
6e90d8a3ab
Mention that aiohttp uses its own custom theme 2021-04-29 23:50:25 +02:00
Pawel Budzynski
260e26cad4 add type hints 2021-04-29 16:28:18 +02:00
Pawel Budzynski
f12f5bc075 add tests 2021-04-29 14:48:56 +02:00
Pawel Budzynski
6f8d9390df autosummary includes instance attributes 2021-04-29 14:15:51 +02:00
Takeshi KOMIYA
29038c9d4c refactor: linkcheck: Call write_linkstat() at the top of process_result() 2021-04-29 18:19:38 +09:00
Takeshi KOMIYA
a7d3e9684d refactor: linkcheck: Use attributes of CheckResult in process_result() 2021-04-29 18:01:42 +09:00
Takeshi KOMIYA
af6e63ab70 Merge branch '4.0.x' into 4.x 2021-04-29 15:06:16 +09:00