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
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
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
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
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
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
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
67fefcc6f9
Merge branch '2.0' into 6418_autodoc_typehints_description
2020-01-30 23:19:45 +09:00
Takeshi KOMIYA
045630ec85
Deprecate sphinx.util.inspect:safe_getmembers()
2020-01-25 23:21:33 +09:00
Takeshi KOMIYA
2e22e96061
Add new event: :event:object-description-transform
2020-01-25 17:12:41 +09:00
Takeshi KOMIYA
f169560395
Merge pull request #6979 from tk0miya/6830_autodoc_private
...
Close #6830 : autodoc: consider a member private if docstring contains :private:
2020-01-11 15:14:52 +09:00
Takeshi KOMIYA
cad1f86dd8
Merge branch '2.0'
2020-01-11 02:56:58 +09:00
Takeshi KOMIYA
5867416612
refactor: Add sphinx.util.inspect.signature()
...
As a successor of sphinx.util.inspect.Singnature, this adds
signature() function behaves like `inspect.signature()`. It is
very similar to way of python's inspect module.
In addition, this also adds stringify_annotation() helper to
sphinx.util.inspect module. With these two functions, we can move
to python's Signature object to represent function signatures
perfectly. It's natural design for python developers than ever.
2020-01-09 00:32:07 +09:00
Takeshi KOMIYA
af2a3c0dde
Merge branch '2.0'
2020-01-08 01:37:53 +09:00
Takeshi KOMIYA
05daa3c7ce
Add sphinx.util.typing:stringify() to represent annotations as string
2020-01-05 01:13:27 +09:00
Takeshi KOMIYA
b968bb91e9
Close #6830 : autodoc: consider a member private if docstring has "private" metadata
2020-01-04 13:28:07 +09:00
Takeshi KOMIYA
7123f4038a
Fix #6559 : Wrong node-ids are generated in glossary directive
2020-01-02 22:03:39 +09:00
Takeshi KOMIYA
e628afd5cd
Merge branch '2.0'
2020-01-01 11:39:46 +09:00
Takeshi KOMIYA
c358e04b09
Close #6558 : glossary: emit a warning for duplicated glossary entry
2019-12-29 22:31:36 +09:00
Takeshi KOMIYA
8dc3315ce5
Deprecate sphinx.roles:Index and make a copy to sphinx.domains.index
2019-12-29 19:12:58 +09:00
Takeshi KOMIYA
4f83793fd0
Move sphinx.directives.other:Index to sphinx.domains.index
2019-12-29 18:21:26 +09:00
Takeshi KOMIYA
ff9e5e6dbd
doc: Sort deprecated list alphabetically
2019-12-28 19:37:43 +09:00
Takeshi KOMIYA
3ddbd73f49
refactor: latex: Deprecate settings.* attributes based on latex_documents
2019-12-27 22:46:16 +09:00
Takeshi KOMIYA
c8074b4a5d
Deprecate sphinx.util:detect_encoding() and ModuleAnalyzer.encoding
2019-12-27 22:08:32 +09:00
Takeshi KOMIYA
7581ee1084
Deprecate sphinx.util:get_module_source()
2019-12-27 01:57:39 +09:00
