summaryrefslogtreecommitdiff
path: root/doc/extdev
Commit message (Collapse)AuthorAgeFilesLines
* refactor: Move _getmro() to sphinx.util.inspect moduleTakeshi KOMIYA2020-12-171-0/+5
|
* Deprecate sphinx.util.osutil.movefile() in favor of os.replace()Jon Dufresne2020-12-131-0/+5
| | | | | | | The utility function movefile() was added in 677d096393bca948eea8fad252bd859ed8142309 to handle existing files on Windows. Since Python 3.3, the stdlib function os.replace() fills this role.
* refactor: Deprecate `no_docstring` argument for Documenter.add_content()Takeshi KOMIYA2020-12-131-0/+6
| | | | | | This deprecates `no_docstring` argument for Documenter.add_content(). After this change, please use Documenter.get_doc() to control (suppress) the content of the python object.
* Fix #8503: autoattribute could not create document for a GenericAliasTakeshi KOMIYA2020-11-291-0/+5
|
* refactor: Deprecate InstanceAttributeDocumenterTakeshi KOMIYA2020-11-261-0/+5
| | | | | InstanceAttributeDocumenter is merged into AttributeDocumenter in #7946 and #8444. So it is no longer needed now.
* Deprecate SlotsAttributeDocumenterTakeshi KOMIYA2020-11-241-0/+5
|
* Merge branch '3.x' into 8460_TypeVarTakeshi KOMIYA2020-11-231-0/+10
|\
| * Merge pull request #8464 from tk0miya/deprecate_Documenter.get_object_membersTakeshi KOMIYA2020-11-231-0/+5
| |\ | | | | | | Deprecate Documenter.get_object_members()
| | * Deprecate Documenter.get_object_members()Takeshi KOMIYA2020-11-211-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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().
| * | refactor: Move _getannotations() to sphinx.util.inspectTakeshi KOMIYA2020-11-221-0/+5
| | |
* | | Fix #8460: autodata directive does not display the detail of TypeVarsTakeshi KOMIYA2020-11-221-0/+5
|/ / | | | | | | | | The details are only shown when automodule directive is used. This allows to document them via other auto* directives.
* | Rename ModuleAnalyzer.parse() to analyze()Takeshi KOMIYA2020-11-221-0/+5
|/ | | | | The word "analyze" is much appropriate for "ModuleAnalyzer" instead of "parse".
* Fix #8443: autodata directive does not support PEP-526 ivarsTakeshi KOMIYA2020-11-201-0/+5
|
* Update CHANGES for PR #8404Takeshi KOMIYA2020-11-141-3/+2
|
* linkcheck: Remove call to is_ssl_error()François Freitag2020-11-121-0/+5
| | | | | | | | 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`.
* Fix #8105: autodoc: the signature of decorated class is incorrectTakeshi KOMIYA2020-11-051-0/+6
| | | | | | | | | 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.
* Fix #6914: Emit a detailed warning when failed to resolve :ref:Takeshi KOMIYA2020-11-031-0/+9
| | | | | | | | | 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.
* 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
|/ /
View Lorry Controller Status