IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
16,687 Commits 2 Branches 219 Tags 163 MiB
3207da1fa8
Commit Graph

16687 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
da9ee49508
Merge pull request #8561 from tk0miya/refactor_UninitializedInstanceAttributeMixin 
Refactor UninitializedInstanceAttributeMixin
 2020-12-22 02:39:11 +09:00
Takeshi KOMIYA
70bb2262d6 Fix #8567: autodoc: Instance attributes are incorrectly added to Parent class 
The instance attributes on subclasses are shown on the document of
parent class unexpectedly because of autodoc modifies `__annotations__`
in place.  This fix creates a copy of `__annotations__` attribute and
attach it to the subclass.
 2020-12-22 02:38:31 +09:00
Takeshi KOMIYA
0d943d8d49
Merge branch '3.x' into refactor_UninitializedInstanceAttributeMixin 2020-12-22 02:30:35 +09:00
Takeshi KOMIYA
067402c69b
Merge pull request #8560 from tk0miya/refactor_UninitializedGlobalVariableMixin 
Refactor UninitializedGlobalVariableMixin
 2020-12-22 02:29:29 +09:00
Takeshi KOMIYA
4e70b5e2f1
Merge pull request #8557 from tk0miya/RuntimeInstanceAttributeDocumenter 
refactor: Rename UninitializedInstanceAttributeMixin
 2020-12-22 02:28:16 +09:00
Dmitry Shachnev
5b779b4201 Fix name of the Hebrew language in test_create_single_index 2020-12-21 20:12:34 +03:00
Takeshi KOMIYA
31cad2ebe7
Merge pull request #8570 from tk0miya/8569_getslots_TypeError 
Fixes #8568. Ignore TypeError from getslots in isslotsattribute
 2020-12-22 01:24:24 +09:00
Takeshi KOMIYA
b3292b55b3 Update CHANGES for PR #8569 2020-12-22 01:14:04 +09:00
Takeshi KOMIYA
22080940e2 doc: Update docstring of getslots() 2020-12-22 00:53:27 +09:00
Rafal Wojdyla
4431f11876 Fixes #8568. Ignore TypeError from getslots in isslotsattribute 2020-12-22 00:52:52 +09:00
Takeshi KOMIYA
97a0babd46
Merge pull request #8564 from tk0miya/8559_AttributeError_for_ForwardRef 
Fix #8559: AttributeError is raised when using ForwardRef
 2020-12-22 00:50:22 +09:00
Takeshi KOMIYA
423e7ab2ca Fix #8559: AttributeError is raised when using ForwardRef 
The restify() helper crashes when ForwardRef is passed.
 2020-12-22 00:37:02 +09:00
Takeshi KOMIYA
990396dd2c autodoc: Enable mocks on importing module 2020-12-21 02:17:23 +09:00
Takeshi KOMIYA
0f0560f07b refactor: autodoc: Use importer.import_module() 2020-12-21 02:04:17 +09:00
Takeshi KOMIYA
edc7f23620 autodoc: Fix enable mocks on importing module 2020-12-21 01:32:50 +09:00
Takeshi KOMIYA
d7c490fefc refactor: autodoc: Do not fill parent field when not global variable 2020-12-21 01:20:58 +09:00
Takeshi KOMIYA
a7e10c1d36 Bump version 2020-12-20 21:29:23 +09:00
Takeshi KOMIYA
323b136410 Bump version 2020-12-20 21:28:29 +09:00
Takeshi KOMIYA
ccb9a3e635 refactor: Rename UninitializedInstanceAttributeMixin 
The instance variables defined at __init__() method are basically
initialized.  So it's not appropriate to call them as "uninitialized".
So this renames the documenter for them to
RuntimeInstanceAttributeMixin.
 2020-12-20 19:35:05 +09:00
Takeshi KOMIYA
79ff248154 Bump to 3.4.0 final 2020-12-20 18:55:08 +09:00
Takeshi KOMIYA
61fd867b37 Merged CHANGES for 3.3.2 into 3.4.0 (unreleased) 2020-12-20 18:53:34 +09:00
Takeshi KOMIYA
723294f922
Merge pull request #8556 from tk0miya/8549_gettext_compact=0 
Fix #8549: i18n: ``-D gettext_compact=0`` is no longer working
 2020-12-20 17:13:10 +09:00
Takeshi KOMIYA
1977f3fcee Fix #8549: i18n: `-D gettext_compact=0` is no longer working 
Since 1bf7fe424, ``-D gettext_compact=0`` is not treated as disabling
the feature.  It is recognized as creating ``0.pot`` because its type is
Any.  This changes it to `[bool, str]`.
 2020-12-20 13:55:35 +09:00
Takeshi KOMIYA
6e8ea8572f
Merge pull request #8552 from tk0miya/8236_napoleon_receives_section 
Close #8236: napoleon: Support numpydoc's "Receives" section
 2020-12-20 13:54:01 +09:00
Takeshi KOMIYA
7f1284f2e7
Merge pull request #8555 from tk0miya/8512_test_comment 
test: Add comment for UnicodeEncodeError handler (refs: #8512)
 2020-12-20 13:53:24 +09:00
Takeshi KOMIYA
2fa15e9396
Merge pull request #8551 from tk0miya/8365_pydomain_xref_missing_context 
Fix #8365: py domain: :type: and :rtype: gives false ambiguous warnings
 2020-12-20 13:49:53 +09:00
Takeshi KOMIYA
9a9d7f3f00 test: Add comment for UnicodeEncodeError handler (refs: #8512) 2020-12-20 01:01:59 +09:00
Takeshi KOMIYA
aae2f19911
Merge pull request #8512 from jbms/fix-nonascii_srcdir 
Fix nonascii_srcdir to work when non-ascii directories aren't supported
 2020-12-20 00:58:08 +09:00
Takeshi KOMIYA
f50b999911 Close #8236: napoleon: Support numpydoc's "Receives" section 2020-12-19 20:29:00 +09:00
Takeshi KOMIYA
30c594fbc5 Fix #8365: py domain: :type: and :rtype: gives false ambiguous warnings 
The searching context like py:module and py:class are missing in the
pending_xref nodes generated from info-field-lists.  This sets these
searching context info to them.
 2020-12-19 18:42:01 +09:00
Takeshi KOMIYA
57ed10c680
Merge pull request #8548 from tk0miya/741_inherited_ivar 
Fix #741: autodoc: inherited-members doesn't support instance attributes on super class
 2020-12-19 00:31:03 +09:00
Takeshi KOMIYA
c0678a4a50 Fix #741: autodoc: inherited-members doesn't support instance attributes on super class 
To support instance attributes on super class, get_class_members() scans
the instance attributes defined at super classes using ModuleAnalyzer.
It allows to generate document for them when users gives :
inherited-members: option.
 2020-12-18 23:24:59 +09:00
Takeshi KOMIYA
dd1615c59d
Merge pull request #8543 from tk0miya/8534_autoattribute_alias_derived 
Fix #8534: autoattribute failed to document a commented attribute in alias dervied class
 2020-12-17 22:35:35 +09:00
Takeshi KOMIYA
e3dc782364
Merge pull request #8546 from tk0miya/8545_slots_attributes_having_docstring 
Fix #8545: autodoc: a __slots__ attribute is not documented even having docstring
 2020-12-17 22:34:58 +09:00
Takeshi KOMIYA
9721327989 Fix #8545: autodoc: a __slots__ attribute is not documented even having docstring 
To avoid filtering __slots__ attributes having docstring at
filter_members(), this passes docstring captured at get_class_members()
to the filter_members() via ObjectMember.
 2020-12-17 22:19:28 +09:00
Takeshi KOMIYA
964392d316 refactor: get_class_members() now returns docstring if available 
To detect a __slots__ attribute has docstring, get_class_members()
returns the docstring of the class member.
 2020-12-17 22:19:27 +09:00
Takeshi KOMIYA
18973f6c1b refactor: autodoc: Add get_class_members() 
To enhance ClassDocumenter, Add a new helper function get_class_members().
At this moment, it is a copy of get_object_members().  It will be
changed to return more detailed information of class members.
 2020-12-17 22:19:12 +09:00
Takeshi KOMIYA
0dbbf1dd54 Fix #8534: autoattribute failed to document a commented attribute in alias dervied class 2020-12-17 22:13:20 +09:00
Takeshi KOMIYA
beeab6ced4
Merge pull request #8542 from tk0miya/8541_autodoc_type_aliases_for_ivar 
Fix #8541: autodoc_type_aliases doesn't work for the instance attrs
 2020-12-17 22:12:06 +09:00
Takeshi KOMIYA
559f01df5b Update CHANGES for PR #8542 2020-12-17 22:03:38 +09:00
Takeshi KOMIYA
385f9f5c19 refactor: autodoc: minor fix 2020-12-17 21:59:09 +09:00
Takeshi KOMIYA
17a32d963a
Merge pull request #8544 from Julian/patch-1 
Minor typo in the contributing info
 2020-12-17 03:45:05 +09:00
Julian Berman
b96d228735
Minor typo in the contributing info 2020-12-16 12:09:17 -05:00
Takeshi KOMIYA
55c110f609 Fix #8541: autodoc_type_aliases doesn't work for the instance attrs 
So far, autodoc obtains type annotations of instance attributes by
ModuleAnalyzer directly.  As a result, autodoc_type_aliases are ignored
for these variables.

This goes to merge type annotations from the class itself and
ModuleAnalyzer's, and get type annotations using `typing.get_type_hints()`
to apply autodoc_type_aliases.
 2020-12-17 01:07:54 +09:00
Takeshi KOMIYA
36e684bf83 refactor: Move _getmro() to sphinx.util.inspect module 2020-12-17 00:46:42 +09:00
Takeshi KOMIYA
bec552c3ef
Merge pull request #8540 from tk0miya/8534_autoattribute_alias 
Fix #8534: autoattribute failed to document a commented attribute in alias class
 2020-12-16 23:47:21 +09:00
Takeshi KOMIYA
caa1d1f3c2 Fix #8534: autoattribute failed to document a commented attribute in alias class 
So far, autoattribute uses "given class name" to fetch comments of
uninitialized instance attributes.  But pycode expects to use "real"
class name on searching attribute comments.

This adds UninitializedInstanceAttributeMixin to handle it simply.
 2020-12-16 02:43:31 +09:00
Takeshi KOMIYA
3e46fda759 refactor: autodoc: Add NonDataDescriptorMixin 2020-12-16 02:36:34 +09:00
Takeshi KOMIYA
00db1ea631
Merge pull request #8538 from jdufresne/os-replace 
Deprecate sphinx.util.osutil.movefile() in favor of os.replace()
 2020-12-14 23:43:00 +09:00
Takeshi KOMIYA
edb1999ac2 Update CHANGES for PR #8524 2020-12-14 23:40:28 +09:00