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,283 Commits 2 Branches 219 Tags
36e684bf83d14e587f0bf48eb0980f41ab66733e
Commit Graph

4762 Commits

Author SHA1 Message Date
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
Takeshi KOMIYA
64498ad0db Merge pull request #8464 from tk0miya/deprecate_Documenter.get_object_members 
Deprecate Documenter.get_object_members()
 2020-11-23 13:24:20 +09:00
Takeshi KOMIYA
37f06cfba9 Fix #8131: linkcheck: Too Many Redirects on HEAD request is treated as broken 2020-11-23 01:45:43 +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
a356d8611e Merge pull request #8468 from tk0miya/refactor_pycode 
Rename ModuleAnalyzer.parse() to analyze()
 2020-11-22 11:46:37 +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
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
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
6620bd91d8 Merge branch '3.x' into 8437_safety_make_clean 2020-11-21 01:56:07 +09:00
Takeshi KOMIYA
e8b7fd2fce Merge branch '3.x' into 8454_graphviz_layout_option 2020-11-21 00:58:19 +09:00
Takeshi KOMIYA
dcd8ff544a Fix #8443: autoattribute does not support uninitialized ivars 2020-11-20 22:39:21 +09:00