Commit Graph

89 Commits

Author SHA1 Message Date
Takeshi KOMIYA
c0f923ee6c refactor: Deprecate AttributeDocumenter.isinstanceattribute() 2020-12-29 20:06:29 +09:00
Takeshi KOMIYA
ce52a90d92 Fix #8592: autodoc: :meta public: does not effect to variables
To control the visibility of variables, ModuleDocumenter have to load
docstring of them on `get_object_members()` phase.  This reimplements
it and `get_module_members()` helper to fetch docstring on earlier
phase (as ClassDocumenter does).
2020-12-27 22:21:34 +09:00
Takeshi KOMIYA
36e684bf83 refactor: Move _getmro() to sphinx.util.inspect module 2020-12-17 00:46:42 +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
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
Takeshi KOMIYA
bb63f03034 Fix #8503: autoattribute could not create document for a GenericAlias 2020-11-29 12:24:10 +09: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
ab844c3f27 Deprecate SlotsAttributeDocumenter 2020-11-24 19:36:14 +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
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
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
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
f344fff55e Fix #8443: autodata directive does not support PEP-526 ivars 2020-11-20 22:38:58 +09:00
Takeshi KOMIYA
78d407cf83 Update CHANGES for PR #8404 2020-11-14 18:55:25 +09:00
François Freitag
683635f5b4 linkcheck: Remove call to is_ssl_error()
This method always returns False, it is dead code. The exception
checking stopped working because Requests library wraps SSL errors in a
`requests.exceptions.SSLError` and no longer throws an
`urllib3.exceptions.SSLError`. The first argument to that exception is
an `urllib3.exceptions.MaxRetryError`.
2020-11-12 19:58:04 +01:00
Takeshi KOMIYA
6d05b1aeb3 Fix #8105: autodoc: the signature of decorated class is incorrect
In #7651, autodoc stops to undecorate the functions on getting the
signature from the callables.  But some kinds of decorators conceals
the correct signature because they pass through their arguments via
`(*args, **kwargs)`.

This restarts to undecorate the functions again as before #7651.
2020-11-05 01:57:40 +09:00
Takeshi KOMIYA
2d37ba4419 autodoc: deprecate SingledispatchFunctionDocumenter
In #7487, SingledispatchFunctionDocumenter is merged into
FunctionDocumenter.  SingledispatchMethodDocumenter is also.  As a result,
They are no longer needed.  So this deprecates them.
2020-10-04 13:50:10 +09:00
Takeshi KOMIYA
5ef4825b57 Close #8081: latex: Allow to add LaTeX package until writing tex file
This postpones the evaluation of LaTeX packages via
``app.add_latex_package()`` to just before writing .tex file.  That
allows extensions to add LaTeX packages during reading and resolving
phase.
2020-09-21 01:01:49 +09:00
Takeshi KOMIYA
46f0b3063d refactor: autodoc: Add EMPTY that matches to no members
Add a special class `_Empty` to make the comparison of
:exclude-members: option simply.  It never matches to any members.
2020-08-03 01:59:53 +09:00
Takeshi KOMIYA
d7a84e83cc Close #8034: autodoc: :private-member: can take an list of member names
Now :private-member: option can take an explicit list of member names to
be documented as its arguments (like :special-members: does).
2020-08-02 01:27:14 +09:00
Takeshi KOMIYA
e98f39d21d Fix #7993: texinfo: TypeError is raised for nested object descriptions
The texinfo writer remembers the current desc node to render
a desc_annotation node.  This makes the mechanism robust to support
nested object descriptions.
2020-07-25 22:57:12 +09:00
Takeshi KOMIYA
891c659ced Deprecate sphinx.util:rpartition() 2020-05-09 22:00:04 +09:00
Takeshi KOMIYA
1ba671a677 Deprecate ignore parameter for Documenter.get_doc() 2020-05-03 01:59:47 +09:00
Takeshi KOMIYA
e5192ba48b refactor: AutosummaryRender 2020-04-25 01:25:00 +09:00
Takeshi KOMIYA
0374d217d4 refactor: Deprecate unused parameters 2020-04-23 22:54:53 +09:00
Takeshi KOMIYA
931bfcca88 refactor: autosummary: Change first argument for AutosummaryRenderer 2020-04-23 22:51:23 +09:00
Takeshi KOMIYA
61b823ad10 refactor: Deprecate unused parameters 2020-04-23 02:25:58 +09:00
Takeshi KOMIYA
53f0d4e646 Deprecate: The module argument of find_autosummary_in_docstring() 2020-04-12 18:14:16 +09:00
Takeshi KOMIYA
fe3782d2ed Deprecate sphinx.ext.autosummary:process_autosummary_toc()
The handler searches autosummary_toc node under root of document and
just under section nodes.  But that is already done in
ToctreeCollector.process_doc().  So it's no longer needed.
2020-03-21 21:44:59 +09:00
Takeshi KOMIYA
2202bff6b2 Deprecate sphinx.ext.autodoc.get_documenters() 2020-03-16 01:58:02 +09:00
Takeshi KOMIYA
d49bec1c67 py domain: Deprecate PyDecoratorMixin 2020-03-07 23:13:06 +09:00
Takeshi KOMIYA
a13ec4f41c Support LaTeX Theming; a set of document class settings (refs: #6672) 2020-03-06 22:11:25 +09:00
Takeshi KOMIYA
2b70875f6a Merge branch 'drop_desc_signature_first' into 3.x 2020-02-22 17:39:56 +09:00
Takeshi KOMIYA
5648b2eb88 Deprecate DescDirective 2020-02-22 12:15:20 +09:00
Takeshi KOMIYA
379f52badf
Merge pull request #7154 from tk0miya/deprecate_Parser.app
Deprecate sphinx.parsers.Parser.app
2020-02-16 22:19:22 +09:00
Takeshi KOMIYA
9409db0771 Deprecate sphinx.parsers.Parser.app 2020-02-15 00:39:34 +09:00
Takeshi KOMIYA
baf4c7df23 Deprecate sphinx.util.inspect.getargspec() 2020-02-14 12:08:52 +09:00
Takeshi KOMIYA
6e0119526a Merge branch '2.0' 2020-02-09 16:21:32 +09:00
Takeshi KOMIYA
df3c0448dd Deprecate desc_signature['first'] 2020-02-09 00:58:42 +09:00
Takeshi KOMIYA
dee8b9eddb Fix #6327: apidoc: Support a python package consisted of __init__.so file 2020-02-08 18:11:48 +09:00
Takeshi KOMIYA
9d301e5b81 refactor: apidoc.shall_skip() 2020-02-08 17:59:29 +09:00
Takeshi KOMIYA
7d6374d983 testing: Add Path.read_text() and Path.read_bytes()
To migrate pathlib.Path in future, compatibile methods are needed
for our Path class.
2020-02-01 11:45:47 +09:00
Takeshi KOMIYA
41032572a5 Merge branch '2.0' 2020-02-01 11:17:03 +09:00
Takeshi KOMIYA
b73cc5652a Update deprecation list 2020-01-31 01:59:24 +09:00
Takeshi KOMIYA
52afc79e1f Merge branch '2.0' into refactor_latex 2020-01-31 01:18:57 +09:00
Takeshi KOMIYA
e7a0af807a Merge branch '2.0' 2020-01-30 23:29:32 +09:00
Takeshi KOMIYA
045630ec85 Deprecate sphinx.util.inspect:safe_getmembers() 2020-01-25 23:21:33 +09:00
Takeshi KOMIYA
cad1f86dd8 Merge branch '2.0' 2020-01-11 02:56:58 +09:00