Commit Graph

16435 Commits

Author SHA1 Message Date
Takeshi KOMIYA
478a1567b6 Fix #8360: Update warning message for numref 2020-11-23 01:36:35 +09:00
Takeshi KOMIYA
3ea1ec84cc
Merge pull request #8463 from tk0miya/refactor_getannotations
refactor: Move _getannotations() to sphinx.util.inspect
2020-11-22 16:02:11 +09:00
Takeshi KOMIYA
a57ce4047c refactor: Move _getannotations() to sphinx.util.inspect 2020-11-22 15:38:01 +09:00
Takeshi KOMIYA
9eb96d5c79 Fix #8460: autodata directive does not display the detail of TypeVars
The details are only shown when automodule directive is used.  This
allows to document them via other auto* directives.
2020-11-22 13:57:48 +09:00
Takeshi KOMIYA
24a329eebe
Merge pull request #8465 from tk0miya/8460_NewType
Fix #8460: autodoc: Support custom types defined by typing.NewType
2020-11-22 13:47:39 +09:00
Takeshi KOMIYA
3840667758 apidoc: Load NewTypeAttributeDocumenter on booting 2020-11-22 13:18:19 +09:00
Takeshi KOMIYA
f9077d238d
Merge pull request #8462 from tk0miya/handle_AttributeError_from_getall
Handle AttributeError from getall() and getslots()
2020-11-22 11:49:00 +09:00
Takeshi KOMIYA
a356d8611e
Merge pull request #8468 from tk0miya/refactor_pycode
Rename ModuleAnalyzer.parse() to analyze()
2020-11-22 11:46:37 +09:00
Takeshi KOMIYA
8bb31c7e3a
Merge pull request #8469 from tk0miya/refactor_test_ext_autodoc_slots
refactor: Rename example class
2020-11-22 11:42:13 +09:00
Takeshi KOMIYA
b4d4d4e808 refactor: Rename example class 2020-11-22 03:06:03 +09:00
Takeshi KOMIYA
8e29d57395 Rename ModuleAnalyzer.parse() to analyze()
The word "analyze" is much appropriate for "ModuleAnalyzer" instead
of "parse".
2020-11-22 02:59:29 +09:00
Takeshi KOMIYA
ad804647b5
Merge pull request #8459 from tk0miya/8452_autodoc_type_aliases_with_autodoc_typehints
Fix #8452: autodoc_type_aliases doesn't work with autodoc_typehints
2020-11-22 01:34:31 +09:00
Takeshi KOMIYA
333e7a447e Fix #8452: autodoc_type_aliases doesn't work with autodoc_typehints 2020-11-22 01:26:32 +09:00
Takeshi KOMIYA
6973888294 Support NewType as a class attribute 2020-11-21 23:56:16 +09:00
Takeshi KOMIYA
be42edea76 refactor: autodoc: Add NewTypeMixin
Separate NewType feature from DataDocumenter to mixin class to share it
with another Documenter.
2020-11-21 23:04:42 +09:00
Takeshi KOMIYA
46a7ea7ada Add NewType support to typing.stringify() and restify() 2020-11-21 23:04:42 +09:00
Takeshi KOMIYA
93d6c212f7 Fix #8460: autodoc: Support custom types defined by typing.NewType
A custom type defined by typing.NewType was rendered as a function
because the generated type is a function having special attributes.
This renders it as a variable.

Note: The module name where the NewType object defined is lost on
generating it.  So it is hard to make cross-reference for these custom
types.
2020-11-21 23:04:42 +09:00
Takeshi KOMIYA
68aa4fb29e
Merge pull request #8466 from tk0miya/refactor_autodoc
refactor: autodoc: Update typehints for "more_content" argument
2020-11-21 20:14:21 +09:00
Takeshi KOMIYA
869825744f refactor: autodoc: Update typehints for "more_content" argument 2020-11-21 20:02:23 +09:00
Takeshi KOMIYA
7e3ba5ddf6 Deprecate Documenter.get_object_members()
At present, the implementation of Documenter.get_object_members() is
only for class objects.  In fact, no subclasses use it (all of them are
overriding the method).

This deprecates Documenter.get_object_members() and copies it to
ClassDocumenter.get_object_members().
2020-11-21 15:42:46 +09:00
Takeshi KOMIYA
a44027059c
Merge pull request #8461 from francoisfreitag/flake8-linkcheck
Make tests/ a Python package
2020-11-21 13:31:23 +09:00
Takeshi KOMIYA
444813a4f3 Handle AttributeError from getall() and getslots() 2020-11-21 13:15:40 +09:00
François Freitag
419e145e36
Make tests/ a Python package
Allows relative imports.
2020-11-20 19:43:02 +01:00
Takeshi KOMIYA
13a986b299
Merge pull request #8450 from tk0miya/8437_safety_make_clean
Fix #8437: Do `make clean` in more safe way
2020-11-21 02:12:35 +09:00
Takeshi KOMIYA
6620bd91d8
Merge branch '3.x' into 8437_safety_make_clean 2020-11-21 01:56:07 +09:00
Takeshi KOMIYA
8a622ba7ea
Merge pull request #8457 from tk0miya/update_deadsnake/action_to_2.0.1
CI: Update deadsnake/action to 2.0.1
2020-11-21 01:17:06 +09:00
Takeshi KOMIYA
296e764198
Merge pull request #8455 from tk0miya/8454_graphviz_layout_option
Fix #8454: graphviz: The layout option for graph and digraph don't work
2020-11-21 01:07:55 +09:00
Takeshi KOMIYA
82382efe9d CI: Update deadsnake/action to 2.0.1
The "add-path" problem is fixed at 2.0.1.
refs: https://github.com/deadsnakes/issues/issues/135
2020-11-21 01:04:45 +09:00
Takeshi KOMIYA
e8b7fd2fce
Merge branch '3.x' into 8454_graphviz_layout_option 2020-11-21 00:58:19 +09:00
Takeshi KOMIYA
18b2707b2a
Merge pull request #8444 from tk0miya/8443_autodata_for_pep526
Fix #8443: autodata directive does not support PEP-526 ivars
2020-11-21 00:57:25 +09:00
Takeshi KOMIYA
90dad94452
Merge pull request #8447 from tk0miya/refactor_getall
refactor autodoc: Add sphinx.util.inspect.getall()
2020-11-20 22:40:24 +09:00
Takeshi KOMIYA
dcd8ff544a Fix #8443: autoattribute does not support uninitialized ivars 2020-11-20 22:39:21 +09:00
Takeshi KOMIYA
f344fff55e Fix #8443: autodata directive does not support PEP-526 ivars 2020-11-20 22:38:58 +09:00
Takeshi KOMIYA
f5289bb699
Merge pull request #8445 from tk0miya/8419_load_language_data.js_only_search_page
Fix #8419: html search: Do not load language_data.js in non-search pages
2020-11-20 22:35:28 +09:00
Takeshi KOMIYA
0071409fe0 Fix #8454: graphviz: The layout option for graph and digraph don't work 2020-11-20 22:34:22 +09:00
Takeshi KOMIYA
ad7be2f224 refactor autodoc: Add sphinx.util.inspect.getall()
Move a function that obtains __all__ attribute from a module to
sphinx.util.inspect module as getall().
2020-11-20 01:18:03 +09:00
Takeshi KOMIYA
ae3a26fd71 Fix #8437: Do make clean in more safe way
When users gives empty BUILDDIR to the `make clean` command on non-make
mode, our Makefile will remove all of files of systems via `rm -rf /*`.
To prevent the catastrophic operation, this makes the `make clean`
command safety.
2020-11-20 01:08:52 +09:00
Takeshi KOMIYA
d0389dce07 Fix #8419: html search: Do not load language_data.js in non-search pages
The ``language_data.js`` is only used on search page.  But it is always
loaded meaninglessly.  This fixes not to load it on all non-search pages.
2020-11-19 02:14:56 +09:00
Takeshi KOMIYA
68c91b1920
Merge pull request #8424 from tk0miya/8222_novalue
autodoc: Add :no-value: option to autoattribute and autodata to suppress the default value of the variable
2020-11-18 22:09:21 +09:00
Takeshi KOMIYA
bf3dd8491b
Merge pull request #8441 from tk0miya/sphinx.util.typing.get_type_hints
refactor: Add sphinx.util.typing.get_type_hints()
2020-11-18 02:20:11 +09:00
Takeshi KOMIYA
6076bff662 refactor: Add sphinx.util.typing.get_type_hints()
Add a simple wrapper of `typing.get_type_hints()` that does not raise
an error on runtime.
2020-11-18 02:01:10 +09:00
Takeshi KOMIYA
3becd56e0e Merge branch '3.x' into 8222_novalue 2020-11-17 23:56:42 +09:00
Takeshi KOMIYA
cfc96fcb22
Merge pull request #8440 from sphinx-doc/deadsnake_ACTIONS_ALLOW_UNSECURE_COMMANDS
test: Pass ACTIONS_ALLOW_UNSECURE_COMMANDS to deadsnake/action
2020-11-17 23:56:17 +09:00
Takeshi KOMIYA
e09b234f7f test: Pass ACTIONS_ALLOW_UNSECURE_COMMANDS to deadsnake/action
The `add-path` command that deadsnake/action internally uses is
disabled by default now [*1].  But the action is still does not
support new style environment files commands [*2].  So this enables
the deprecated command via `ACTIONS_ALLOW_UNSECURE_COMMANDS` envvar.

[*1]: https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands/
[*2]: https://github.com/deadsnakes/issues/issues/135
2020-11-17 23:39:54 +09:00
Takeshi KOMIYA
5df381e8e0
Merge pull request #8435 from tk0miya/8434_autodoc_type_aliases_for_variables
Fix #8434: autodoc_type_aliases does not effect to variables
2020-11-17 22:42:38 +09:00
Takeshi KOMIYA
f203a15141 autodoc: Fix :no-value: option for autoattribute does not work 2020-11-17 22:40:40 +09:00
Takeshi KOMIYA
aab9ba7641
Merge pull request #8428 from tk0miya/apply_flake8_to_tests_directory
[WIP] test: Apply flake8 to tests/ directory
2020-11-17 22:32:23 +09:00
Takeshi KOMIYA
be008a049e test: Apply flake8 to tests/ directory 2020-11-16 20:31:50 +09:00
Takeshi KOMIYA
af04b64906
Merge pull request #8429 from tk0miya/refactor_test_intl
test: Merge testcases having the same name
2020-11-16 02:44:58 +09:00
Takeshi KOMIYA
b615fcca85
Merge pull request #8436 from francoisfreitag/better-certs
linkcheck: Specify subjectAltName in test self-signed certificate
2020-11-16 02:42:34 +09:00