summaryrefslogtreecommitdiff
path: root/doc/extdev/deprecated.rst
Commit message (Collapse)AuthorAgeFilesLines
* autodoc: deprecate SingledispatchFunctionDocumenterTakeshi KOMIYA2020-10-041-0/+10
| | | | | | In #7487, SingledispatchFunctionDocumenter is merged into FunctionDocumenter. SingledispatchMethodDocumenter is also. As a result, They are no longer needed. So this deprecates them.
* Close #8081: latex: Allow to add LaTeX package until writing tex fileTakeshi KOMIYA2020-09-211-0/+10
| | | | | | | 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.
* refactor: autodoc: Add `EMPTY` that matches to no membersTakeshi KOMIYA2020-08-031-0/+5
| | | | | Add a special class `_Empty` to make the comparison of :exclude-members: option simply. It never matches to any members.
* Close #8034: autodoc: :private-member: can take an list of member namesTakeshi KOMIYA2020-08-021-0/+5
| | | | | Now :private-member: option can take an explicit list of member names to be documented as its arguments (like :special-members: does).
* Fix #7993: texinfo: TypeError is raised for nested object descriptionsTakeshi KOMIYA2020-07-251-0/+5
| | | | | | The texinfo writer remembers the current desc node to render a desc_annotation node. This makes the mechanism robust to support nested object descriptions.
* Deprecate sphinx.util:rpartition()Takeshi KOMIYA2020-05-091-0/+5
|
* Deprecate ignore parameter for Documenter.get_doc()Takeshi KOMIYA2020-05-031-0/+10
|
* refactor: AutosummaryRenderTakeshi KOMIYA2020-04-251-0/+11
|
* refactor: Deprecate unused parametersTakeshi KOMIYA2020-04-231-0/+6
|
* refactor: autosummary: Change first argument for AutosummaryRendererTakeshi KOMIYA2020-04-231-0/+7
|
* refactor: Deprecate unused parametersTakeshi KOMIYA2020-04-231-0/+12
|
* Deprecate: The module argument of find_autosummary_in_docstring()Takeshi KOMIYA2020-04-121-0/+6
|
* Deprecate sphinx.ext.autosummary:process_autosummary_toc()Takeshi KOMIYA2020-03-211-0/+5
| | | | | | 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.
* Deprecate sphinx.ext.autodoc.get_documenters()Takeshi KOMIYA2020-03-161-0/+5
|
* py domain: Deprecate PyDecoratorMixinTakeshi KOMIYA2020-03-071-0/+5
|
* Support LaTeX Theming; a set of document class settings (refs: #6672)Takeshi KOMIYA2020-03-061-0/+5
|
* Merge branch 'drop_desc_signature_first' into 3.xTakeshi KOMIYA2020-02-221-0/+5
|\
| * Deprecate desc_signature['first']Takeshi KOMIYA2020-02-091-0/+5
| |
* | Deprecate DescDirectiveTakeshi KOMIYA2020-02-221-0/+5
| |
* | Merge pull request #7154 from tk0miya/deprecate_Parser.appTakeshi KOMIYA2020-02-161-0/+5
|\ \ | | | | | | Deprecate sphinx.parsers.Parser.app
| * | Deprecate sphinx.parsers.Parser.appTakeshi KOMIYA2020-02-151-0/+5
| | |
* | | Deprecate sphinx.util.inspect.getargspec()Takeshi KOMIYA2020-02-141-0/+5
|/ /
* | Merge branch '2.0'Takeshi KOMIYA2020-02-091-0/+10
|\ \ | |/ |/|
| * Fix #6327: apidoc: Support a python package consisted of __init__.so fileTakeshi KOMIYA2020-02-081-0/+5
| |
| * refactor: apidoc.shall_skip()Takeshi KOMIYA2020-02-081-0/+5
| |
* | testing: Add Path.read_text() and Path.read_bytes()Takeshi KOMIYA2020-02-011-0/+10
| | | | | | | | | | To migrate pathlib.Path in future, compatibile methods are needed for our Path class.
* | Merge branch '2.0'Takeshi KOMIYA2020-02-011-0/+55
|\ \ | |/
| * Update deprecation listTakeshi KOMIYA2020-01-311-0/+30
| |
| * Merge branch '2.0' into refactor_latexTakeshi KOMIYA2020-01-311-3/+29
| |\
| * | refactor: latex: Deprecate settings.* attributes based on latex_documentsTakeshi KOMIYA2019-12-271-0/+25
| | |
* | | Merge branch '2.0'Takeshi KOMIYA2020-01-301-0/+5
|\ \ \ | | |/ | |/|
| * | Deprecate sphinx.util.inspect:safe_getmembers()Takeshi KOMIYA2020-01-251-0/+5
| | |
* | | Merge branch '2.0'Takeshi KOMIYA2020-01-111-12/+3
|\ \ \ | |/ /
| * | refactor: Add sphinx.util.inspect.signature()Takeshi KOMIYA2020-01-091-12/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | | Merge branch '2.0'Takeshi KOMIYA2020-01-081-0/+20
|\ \ \ | |/ /
| * | Add sphinx.util.typing:stringify() to represent annotations as stringTakeshi KOMIYA2020-01-051-0/+15
| | |
| * | Fix #6559: Wrong node-ids are generated in glossary directiveTakeshi KOMIYA2020-01-021-0/+5
| | |
* | | Merge branch '2.0'Takeshi KOMIYA2020-01-011-0/+30
|\ \ \ | |/ /
| * | Deprecate sphinx.roles:Index and make a copy to sphinx.domains.indexTakeshi KOMIYA2019-12-291-0/+5
| | |
| * | Move sphinx.directives.other:Index to sphinx.domains.indexTakeshi KOMIYA2019-12-291-0/+5
| | |
| * | doc: Sort deprecated list alphabeticallyTakeshi KOMIYA2019-12-281-5/+5
| |/
| * Deprecate sphinx.util:detect_encoding() and ModuleAnalyzer.encodingTakeshi KOMIYA2019-12-271-0/+15
| |
| * Deprecate sphinx.util:get_module_source()Takeshi KOMIYA2019-12-271-0/+5
| |
* | Close #6558: glossary: emit a warning for duplicated glossary entryTakeshi KOMIYA2019-12-291-0/+5
|/
* Add IndexDomainTakeshi KOMIYA2019-12-221-0/+10
|
* Deprecate sphinx.io.FiletypeNotFoundError and get_filetype()Takeshi KOMIYA2019-12-161-0/+10
|
* LaTeX: avoid quotes and TeX ligature replacements in PDF outputjfbu2019-12-151-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Refs: #6890 The comma character is not TeX-escaped because it is frequent in general text and escaping it would make the LaTeX output larger for only dealing with the problem of the LaTeX-ligature of ,, into a single character. And one there is problem with the commas in options to Verbatim from PygmentsBridge. The hyphen character is escaped (not in ids and URIs!) to \sphinxhyphen{} for both Unicode and non-Unicode engines. This is needed to work around hyperref transforming -- and --- from section titles into EN DASH resp. EM DASH in PDF bookmarks. https://github.com/latex3/hyperref/issues/112 Note to expert LaTeX users: if Sphinx latex user with xelatex has - turned off Smart Quotes for some reason, - but does want TeX ligatures and thus overrode Sphinx latex_elements['fontenc'] default (since #6888) to this effect, then this should be added to LaTeX preamble: \def\sphinxhyphen#1{-}% (\protected is now not needed) \let\sphinxhyphenforbookmarks\sphinxhyphen
* Make escape() and hlescape() as public APIs of texescapeTakeshi KOMIYA2019-11-161-2/+2
|
* Deprecate sphinx.util.texescape.tex_escape_mapTakeshi KOMIYA2019-11-161-0/+10
|
* gettext: Use template file to generate message catalogTakeshi KOMIYA2019-11-081-0/+5
|
View Lorry Controller Status