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,311 Commits 2 Branches 219 Tags
423e7ab2ca42123584504ef03e0a3c07b9369275
Commit Graph

4776 Commits

Author SHA1 Message Date
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
323b136410 Bump version 2020-12-20 21:28:29 +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
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
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
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
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
559f01df5b Update CHANGES for PR #8542 2020-12-17 22:03:38 +09: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
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
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
Jon Dufresne
cb4f76fca2 Deprecate sphinx.util.osutil.movefile() in favor of os.replace() 
The utility function movefile() was added in
677d096393 to handle existing files on
Windows. Since Python 3.3, the stdlib function os.replace() fills this
role.
 2020-12-13 09:36:10 -08: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
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
Takeshi KOMIYA
8faa8ba7ab Update CHANGES for PR #8523 2020-12-12 15:16:51 +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
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
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
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
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
e6e23aa45b Merge pull request #8488 from tk0miya/deprecate_InstanceAttributeDecorator 
refactor: Deprecate InstanceAttributeDocumenter
 2020-11-26 20:13:03 +09:00
François Freitag
6b90a63f08 Fix #6629: linkcheck: Handle rate-limiting 
Follow the Retry-After header if present, otherwise use an exponential
back-off.
 2020-11-25 17:34:55 +01:00
Takeshi KOMIYA
93c9ce5cd8 refactor: Deprecate InstanceAttributeDocumenter 
InstanceAttributeDocumenter is merged into AttributeDocumenter in #7946
and #8444. So it is no longer needed now.
 2020-11-26 01:22:25 +09:00
Takeshi KOMIYA
c941b9cb14 Merge pull request #8481 from tk0miya/8480_slots_attributes 
Fix #8480: autoattribute could not create document for __slots__ attributes
 2020-11-24 21:53:48 +09:00
Takeshi KOMIYA
ab844c3f27 Deprecate SlotsAttributeDocumenter 2020-11-24 19:36:14 +09:00
Takeshi KOMIYA
bbc1ce368c Update CHANGES for PR #8478 2020-11-23 17:24:28 +09:00
Takeshi KOMIYA
0131f776fb Merge pull request #8475 from tk0miya/8131_too_many_redirects 
Extend linkchecker GET fallback logic to handle Too Many Redirects
 2020-11-23 17:16:51 +09:00
Takeshi KOMIYA
bffa44670e CHANGES: Fix line length 2020-11-23 17:00:48 +09:00
Takeshi KOMIYA
7a0605ade1 Update CHANGES 
Co-authored-by: François Freitag <mail@franek.fr>
 2020-11-23 16:57:45 +09:00
Takeshi KOMIYA
50dad211ed Fix #8480: autoattribute could not create document for __slots__ attributes 2020-11-23 15:28:53 +09:00
Takeshi KOMIYA
5ebacaec89 Merge branch '3.x' into 8460_TypeVar 2020-11-23 13:58:41 +09:00