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
a00d62c445
Merge branch '3.x'
2020-11-22 16:04:07 +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
3a4ae2092a
Merge branch '3.x'
2020-11-21 01:01:36 +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
bbcd471557
Merge branch '3.x'
2020-11-09 02:50:08 +09:00
Takeshi KOMIYA
8bf84167a3
Merge branch '3.x'
2020-11-05 02:21:47 +09: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
0e98e9b1a8
Fix #6914 : Emit a detailed warning when failed to resolve :ref:
...
To be clear the ambiguous warning for missing-reference :ref:,
this separates the warning to missing-label and missing-caption.
To emit a warning dynamically, this also adds a new event:
`warn-missing-reference` to customize warning messages via event
handlers.
2020-11-03 02:27:43 +09:00
Takeshi KOMIYA
598b85da75
Merge branch '3.x' into master
2020-10-04 22:41:44 +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
26ea870267
Merge branch '3.x' into master
2020-10-03 13:43:21 +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
bec30596a8
Merge branch '3.x' into master
2020-09-13 10:54:21 +09:00
Chris Sewell
46177f6af3
Correct numbers
2020-08-21 01:58:28 +01:00
Chris Sewell
5c744d8342
📚 DOCS: Improve build process overview
2020-08-20 22:37:37 +01:00
Takeshi KOMIYA
a8927bcd3e
Merge branch '3.x'
2020-08-08 18:16:59 +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
9969239b22
Merge branch '3.x'
2020-08-01 18:08:23 +09:00
Takeshi KOMIYA
c14c00397e
Merge branch '3.x'
2020-08-01 16:59:00 +09:00
Takeshi KOMIYA
f71b26ac56
Merge branch '3.x' into 7993_texinfo_for_nested_desc
2020-08-01 15:50:55 +09:00
Chris Holdgraf
60b105d6aa
several documentation improvements to theming, templating, and extension development
2020-07-29 10:38:18 +01: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
ec3754bd94
Merge branch '3.x'
2020-07-05 01:32:54 +09:00
Chris Holdgraf
ef03bcc6ea
output files comment
2020-07-02 13:46:44 -07:00
Chris Holdgraf
853060a646
events
2020-07-02 13:42:53 -07:00
Takeshi KOMIYA
068b9b5738
Merge branch '3.x'
2020-06-04 00:18:30 +09:00
Jakob Lykke Andersen
ff7545a191
Allow NoUri from 'missing-reference' handlers.
...
Also extend documentation of 'missing-reference'.
2020-05-17 12:34:33 +02:00
Takeshi KOMIYA
3c7d35d2a2
Merge branch '3.x'
2020-05-17 19:12:56 +09:00
Takeshi KOMIYA
891c659ced
Deprecate sphinx.util:rpartition()
2020-05-09 22:00:04 +09:00
Takeshi KOMIYA
75203967d8
Merge branch '3.x'
2020-05-04 00:15:20 +09:00
Takeshi KOMIYA
1ba671a677
Deprecate ignore parameter for Documenter.get_doc()
2020-05-03 01:59:47 +09:00
Takeshi KOMIYA
a86346aca6
Remove deprecated features marked as RemovedInSphinx40Warning
2020-04-29 15:12:39 +09:00
Takeshi KOMIYA
42aa293679
Merge branch '3.x'
2020-04-27 00:54:23 +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
1aca70cf80
Merge branch '3.x'
2020-04-13 23:36:49 +09:00
Takeshi KOMIYA
53f0d4e646
Deprecate: The module argument of find_autosummary_in_docstring()
2020-04-12 18:14:16 +09:00
Takeshi KOMIYA
eb46db036f
doc: Fix indentation
2020-04-11 15:44:07 +09:00
