summaryrefslogtreecommitdiff
path: root/doc/extdev
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.
* Correct numbersChris Sewell2020-08-211-6/+5
|
* 📚 DOCS: Improve build process overviewChris Sewell2020-08-201-1/+3
|
* 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).
* Merge branch '3.x' into 7993_texinfo_for_nested_descTakeshi KOMIYA2020-08-011-48/+40
|\
| * several documentation improvements to theming, templating, and extension ↵Chris Holdgraf2020-07-291-48/+40
| | | | | | | | development
* | 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.
* output files commentChris Holdgraf2020-07-021-1/+1
|
* eventsChris Holdgraf2020-07-021-0/+34
|
* Allow NoUri from 'missing-reference' handlers.Jakob Lykke Andersen2020-05-171-2/+6
| | | | Also extend documentation of 'missing-reference'.
* 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
|
* doc: Fix indentationTakeshi KOMIYA2020-04-111-12/+12
|
* Fix #7418: std domain: duplication warning for glossary terms is case ↵Takeshi KOMIYA2020-04-091-1/+1
| | | | insensitive
* 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
|
* doc: Update docsTakeshi KOMIYA2020-03-071-2/+1
|
* doc: Remove a mention to todo ext. from env-merge-infoTakeshi KOMIYA2020-03-061-5/+0
|
* 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-312-3/+37
| |\
| * | refactor: latex: Deprecate settings.* attributes based on latex_documentsTakeshi KOMIYA2019-12-271-0/+25
| | |
* | | Merge branch '2.0'Takeshi KOMIYA2020-01-302-1/+6
|\ \ \ | | |/ | |/|
| * | Merge branch '2.0' into 6418_autodoc_typehints_descriptionTakeshi KOMIYA2020-01-301-0/+5
| |\ \
| | * | Deprecate sphinx.util.inspect:safe_getmembers()Takeshi KOMIYA2020-01-251-0/+5
| | | |
| * | | Add new event: :event:`object-description-transform`Takeshi KOMIYA2020-01-251-0/+8
| |/ /
* | | Merge pull request #6979 from tk0miya/6830_autodoc_privateTakeshi KOMIYA2020-01-111-0/+8
|\ \ \ | | | | | | | | Close #6830: autodoc: consider a member private if docstring contains :private:
| * | | Close #6830: autodoc: consider a member private if docstring has "private" ↵Takeshi KOMIYA2020-01-041-0/+8
| | | | | | | | | | | | | | | | metadata
* | | | 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
|\ \ \ \ | |/ / / | | / / | |/ / |/| |
View Lorry Controller Status