Takeshi KOMIYA
8bf84167a3
Merge branch '3.x'
2020-11-05 02:21:47 +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
Takeshi KOMIYA
a5dadeb890
Fix #7418 : std domain: duplication warning for glossary terms is case insensitive
2020-04-09 01:56:13 +09:00
Takeshi KOMIYA
90fb44ee43
Merge branch '3.x'
2020-03-23 00:07:51 +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
c7e590818a
Merge branch '3.x'
2020-03-21 17:53:22 +09:00
Takeshi KOMIYA
2202bff6b2
Deprecate sphinx.ext.autodoc.get_documenters()
2020-03-16 01:58:02 +09:00
Takeshi KOMIYA
d0cff3b4fc
Deprecate sphinx.util.pycompat.execfile_()
2020-03-16 01:41:58 +09:00
Takeshi KOMIYA
e116613a3a
Merge branch '3.x'
2020-03-10 01:15:52 +09:00
Takeshi KOMIYA
d49bec1c67
py domain: Deprecate PyDecoratorMixin
2020-03-07 23:13:06 +09:00
Takeshi KOMIYA
3e0618ba3a
Deprecate codes for docutils-0.13 or 0.14
2020-03-07 19:36:41 +09:00
Takeshi KOMIYA
f13c546862
doc: Update docs
2020-03-07 02:00:50 +09:00
Takeshi KOMIYA
7c8b32a85d
doc: Remove a mention to todo ext. from env-merge-info
2020-03-06 22:42: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
