Commit Graph

16720 Commits

Author SHA1 Message Date
Takeshi KOMIYA
663074e3ce
Merge pull request #8626 from tk0miya/refactor_test_autosummary
refactor: test: Use rollback_sysmodules fixture in test_ext_autosummary
2021-01-01 13:12:35 +09:00
Takeshi KOMIYA
05b67f2a3e
Merge pull request #8633 from tk0miya/merge_3.4.x
Merge 3.4.x to 3.x
2021-01-01 13:11:56 +09:00
Takeshi KOMIYA
d82a3c2047
Merge pull request #8625 from tk0miya/refactor_autodoc3
refactor: autodoc: Allow None value from get_doc()
2021-01-01 13:08:36 +09:00
Takeshi KOMIYA
63e0127b38 refactor autodoc to adjust new AttributeDocumenter 2020-12-31 21:37:35 +09:00
Takeshi KOMIYA
9ec65ff039 Merge branch '3.4.x' into merge_3.4.x 2020-12-31 21:33:43 +09:00
Takeshi KOMIYA
0f1fcdc113
Merge pull request #8632 from tk0miya/fix_test_markup
Fix test: missing compound class for kbd tag
2020-12-31 21:30:56 +09:00
Takeshi KOMIYA
5383846ced
Merge pull request #8622 from tk0miya/8616_AttributeError_for_non_class
Fix #8616: autodoc: AttributeError when non-class is passed to autoclass
2020-12-31 21:22:06 +09:00
Takeshi KOMIYA
2eb8927b89 Fix test: missing compound class for kbd tag 2020-12-31 21:20:38 +09:00
Takeshi KOMIYA
1353a7b82f
Merge branch '3.4.x' into 8616_AttributeError_for_non_class 2020-12-31 21:12:29 +09:00
Takeshi KOMIYA
b31b8df9bf
Merge pull request #8620 from tk0miya/8619_compound_kbd
Close #8619: html: kbd role generates customizable HTML tags for compound keys
2020-12-31 21:11:42 +09:00
Takeshi KOMIYA
60557715d2 Fix #8629: html: A type warning for html_use_opensearch is shown twice 2020-12-31 18:45:00 +09:00
Takeshi KOMIYA
f1a051fdfc Fix #8315: autodoc: Failed to resolve struct.Struct type annotation
The builtin module, ``struct.Struct`` does not have correct module
name since Python 3.8.  This allows to refer it automatically.
2020-12-31 14:25:05 +09:00
Takeshi KOMIYA
332d80ba84
Merge pull request #8621 from tk0miya/8618_kbd_for_single_separator
Fix #8618: html: incorrect HTML for single compound-kdb separators
2020-12-31 10:57:40 +09:00
Takeshi KOMIYA
54e8b8d9bc refactor: test: Use rollback_sysmodules fixture in test_ext_autosummary 2020-12-31 10:55:45 +09:00
Takeshi KOMIYA
2e0ea32111 refactor: autodoc: Allow None value from get_doc()
Now Documenter.get_doc() can reeturn None if it can't have any docstring.
So its caller should handle None value.
2020-12-31 10:51:53 +09:00
Takeshi KOMIYA
a1d501d876
Merge pull request #8615 from tk0miya/refactor_autodoc
refactor: autodoc: Replace ClassAttribute by ObjectMember
2020-12-31 10:44:09 +09:00
Takeshi KOMIYA
1dd0cc8494
Merge pull request #8611 from tk0miya/8602_process-docstring_for_nondatadescriptors
Fix #8602: autodoc: The ``autodoc-process-docstring`` event is emitted to the non-datadescriptors unexpectedly
2020-12-31 10:43:20 +09:00
Takeshi KOMIYA
e3b1fdeeeb
Merge branch '3.4.x' into 8602_process-docstring_for_nondatadescriptors 2020-12-31 10:13:03 +09:00
Takeshi KOMIYA
0f8debe558 Fix #8616: autodoc: AttributeError when non-class is passed to autoclass
Since 3.4.0, AttributeError is raised when non-class object is passed to
the autoclass directive.  It has built successfully before 3.4.0
release.  So this handles the exception on generating "alias" text.
2020-12-30 23:29:06 +09:00
Takeshi KOMIYA
6a53c53d53 Fix #8618: html: incorrect HTML for single compound-kdb separators 2020-12-30 21:12:00 +09:00
Takeshi KOMIYA
8e5f4e5616 Close #8619: html: kbd role generates customizable HTML tags for compound keys 2020-12-30 20:36:09 +09:00
Takeshi KOMIYA
21698c1446
Merge pull request #8614 from tk0miya/deprecate_AttributeDocumenter_isinstanceattribute
refactor: Deprecate AttributeDocumenter.isinstanceattribute()
2020-12-30 19:47:17 +09:00
Takeshi KOMIYA
839d2594a2 refactor: autodoc: Replace ClassAttribute by ObjectMember
After the series of refactoring, it would be better to use ObjectMember
directly inside get_class_members(). And ClassAttribute is no longer
needed.
2020-12-30 12:17:05 +09:00
Takeshi KOMIYA
c99412695d
Merge pull request #8292 from tk0miya/update_coding_style
docs: Update coding style
2020-12-30 01:44:03 +09:00
Takeshi KOMIYA
c0f923ee6c refactor: Deprecate AttributeDocumenter.isinstanceattribute() 2020-12-29 20:06:29 +09:00
Takeshi KOMIYA
ae9768385a Merge branch '3.4.x' into 3.x 2020-12-29 19:40:40 +09:00
Takeshi KOMIYA
3f560cd672
Merge pull request #8612 from tk0miya/reduce_Warning
refactor: Reduce warnings on testing
2020-12-29 19:39:41 +09:00
Takeshi KOMIYA
935d7425cc
Merge pull request #8613 from tk0miya/refactor_autosummary_warnings
refactor: autosummary: Do not import deprecated documenter; SingledispatchFunctionDocumenter
2020-12-29 19:38:57 +09:00
Takeshi KOMIYA
40a354425a refactor: autosummary: Do not import deprecated documenter; SingledispatchFunctionDocumenter 2020-12-29 19:25:35 +09:00
Takeshi KOMIYA
f054b9b976 refactor: Reduce warnings on testing 2020-12-29 19:23:46 +09:00
Takeshi KOMIYA
3f7bf48715 Merge branch '3.4.x' into 3.x 2020-12-29 18:33:36 +09:00
Takeshi KOMIYA
aaee3520f3
Merge pull request #8607 from tk0miya/8164_subclass_of_mocked_class
Fix #8164: autodoc: Classes that inherit mocked class are not documented
2020-12-29 18:31:53 +09:00
Takeshi KOMIYA
97f36a2d02 Fix #8602: autodoc: The `autodoc-process-docstring` event is emitted to the non-datadescriptors unexpectedly 2020-12-29 18:04:24 +09:00
Takeshi KOMIYA
b24ae7e206
Merge pull request #8610 from tkoyama010/patch-1
🆕 FreeFEM in EXAMPLES
2020-12-29 11:14:25 +09:00
Tetsuo Koyama
6fcc4daa73
🆕 FreeFEM in EXAMPLES 2020-12-29 03:19:46 +09:00
Takeshi KOMIYA
3f8f6b5fa1
Merge pull request #8609 from altendky/patch-1
Minor docstring typo fix -> existence
2020-12-29 01:52:23 +09:00
Takeshi KOMIYA
85567748d9 Fix #8164: autodoc: Classes that inherit mocked class are not documented
Use ismock() to check a module member is a mocked or not. It allows not
to skip subclasses of mocked class.
2020-12-29 00:26:23 +09:00
Takeshi KOMIYA
1a659c6ca7 testing: Add rollback_sysmodules fixture to unload modules after tests 2020-12-29 00:26:23 +09:00
Kyle Altendorf
46055367cf
Minor docstring typo fix -> existence 2020-12-28 10:02:17 -05:00
Takeshi KOMIYA
476169284d autodoc: Add a helper that checks the object is mocked; ismock() 2020-12-28 21:50:36 +09:00
Takeshi KOMIYA
f18e988dea
Merge pull request #8601 from tk0miya/8306_autosummary_mocks_are_documented
Fix #8306: autosummary: mocked modules are documented as empty page
2020-12-28 17:42:22 +09:00
Takeshi KOMIYA
150f788e0e
Merge pull request #8600 from tk0miya/8132_project_copyright
Close #8132: Add project_copyright confval as an alias of copyright
2020-12-28 17:26:49 +09:00
Takeshi KOMIYA
05518851d3
Merge branch '3.x' into 8306_autosummary_mocks_are_documented 2020-12-28 17:25:09 +09:00
Takeshi KOMIYA
91fa0ceb22
Merge pull request #8598 from tk0miya/8094_texinfo_images_not_copied
Fix #8094: texinfo: images on the different directory with document are not copied
2020-12-28 17:24:23 +09:00
Takeshi KOMIYA
a4da54c4d6
Merge pull request #8605 from xuhdev/patch-1
Doc: Correct type: "TypeAlias" -> "AliasType"
2020-12-28 16:49:17 +09:00
Takeshi KOMIYA
146092e35a
Merge branch '3.x' into 8094_texinfo_images_not_copied 2020-12-28 16:48:02 +09:00
Takeshi KOMIYA
119ddf92ff
Merge pull request #8595 from tk0miya/8594_empty_all
Fix #8594: autodoc: empty __all__ attribute is ignored
2020-12-28 16:47:31 +09:00
Hong Xu
d9ca895dbb
Update autodoc.rst 2020-12-27 21:24:19 -08:00
Hong Xu
6927130ff1
Doc: Correct type: "TypeAlias" -> "AliasType" 2020-12-27 21:23:31 -08:00
Takeshi KOMIYA
c5a9d04d45
Merge branch '3.x' into 8132_project_copyright 2020-12-28 13:56:11 +09:00