summaryrefslogtreecommitdiff
path: root/sphinx/ext
Commit message (Collapse)AuthorAgeFilesLines
...
* | | | | | | | | | | | | | | | | | | | | | | | Merge pull request #9800 from hoefling/extlinks/replacements-checkTakeshi KOMIYA2021-11-291-0/+44
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | |/ / / / / / / / / / / / / / / / / / / / / / / |/| | | | | | | | | | | | | | | | | | | | | | | Proposal: check if hardcoded URLs can be replaced with extlinks
| * | | | | | | | | | | | | | | | | | | | | | | apply review suggestionsOleg Hoefling2021-11-121-7/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
| * | | | | | | | | | | | | | | | | | | | | | | extlinks: replacement suggestions for hardcoded linksoleg.hoefling2021-11-121-0/+45
| | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ / | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
* | | | | | | | | | | | | | | | | | | | | | | Merge branch '4.3.x' into 4.xTakeshi KOMIYA2021-11-281-1/+1
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Merge pull request #9890 from tk0miya/9844_preserve_defaults_for_partialTakeshi KOMIYA2021-11-271-1/+1
| |\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fix #9844: autodoc: Failed to preserve defvalues for partial function
| | * | | | | | | | | | | | | | | | | | | | | | | Fix #9844: autodoc: Failed to preserve defvalues for partial functionTakeshi KOMIYA2021-11-261-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | | | Merge remote-tracking branch 'origin/4.x' into 4.xTakeshi KOMIYA2021-11-262-5/+27
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Merge pull request #9831 from Yoshanuikabundi/autosummary___all__Takeshi KOMIYA2021-11-262-5/+27
| |\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | Allow autosummary to respect __all__
| | * | | | | | | | | | | | | | | | | | | | | | | | Fix lints and reorder args of members_ofJosh Mitchell2021-11-221-6/+7
| | | | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | | | Fixed missed ignore___all__ -> ignore_module_allJosh Mitchell2021-11-152-8/+8
| | | | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | | | Corrections from review by tk0miyaJosh Mitchell2021-11-151-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | |
| | * | | | | | | | | | | | | | | | | | | | | | | | #2021: Allow autosummary to respect __all__Josh Mitchell2021-11-152-5/+26
| | | |_|/ / / / / / / / / / / / / / / / / / / / / | | |/| | | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | | | Merge branch '4.3.x' into 4.xTakeshi KOMIYA2021-11-261-5/+5
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | |/ / / / / / / / / / / / / / / / / / / / / / / / |/| | / / / / / / / / / / / / / / / / / / / / / / | | |/ / / / / / / / / / / / / / / / / / / / / / | |/| | | | | | | | | | | | | | | | | | | | | |
| * | | | | | | | | | | | | | | | | | | | | | | Fix #9868: imgmath: Crashed if the dvisvgm command failed to convert equationTakeshi KOMIYA2021-11-231-5/+5
| | |/ / / / / / / / / / / / / / / / / / / / / | |/| | | | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | | | | | Merge branch '4.3.x' into 4.xTakeshi KOMIYA2021-11-232-3/+10
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | |/ / / / / / / / / / / / / / / / / / / / / /
| * | | | | | | | | | | | | | | | | | | | | | Remove debug printTakeshi KOMIYA2021-11-231-1/+0
| | | | | | | | | | | | | | | | | | | | | | |
| * | | | | | | | | | | | | | | | | | | | | | Merge branch '4.3.x' into 9864_mathjax_loading_methodTakeshi KOMIYA2021-11-231-1/+1
| |\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \
| | * | | | | | | | | | | | | | | | | | | | | | Fix #9879: autodoc: AttributeError for object having invalid __doc__Takeshi KOMIYA2021-11-221-1/+1
| | |/ / / / / / / / / / / / / / / / / / / / /
| * | | | | | | | | | | | | | | | | | | | | | Fix #9864: mathjax: Failed to render equations via MathJax v2Takeshi KOMIYA2021-11-211-2/+10
| |/ / / / / / / / / / / / / / / / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | MathJax library has been loaded via "defer" method since v4.3.0. But it prevents to work MathJax v2. This rollbacks the change and use "async" method as default again. To support changing the loading method, this allows to specify it via mathjax_options.
* | | | | | | | | | | | | | | | | | | | | | Merge branch '4.x' into 9878_mathjax_config_should_be_loaded_earlierTakeshi KOMIYA2021-11-231-2/+10
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \
| * | | | | | | | | | | | | | | | | | | | | | Fix #9866: autodoc: doccoment for the imported class was ignoredTakeshi KOMIYA2021-11-211-2/+10
| |/ / / / / / / / / / / / / / / / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Autodoc tried to scan doccomment on the module where the class defined. But it failed to get it if the class is imported from other module. This analyzes the target module to obtain the doccomment.
* | | | | | | | | | | | | | | | | | | | | | Fix #9878: mathjax: MathJax config is placed after loading MathJaxTakeshi KOMIYA2021-11-221-5/+5
|/ / / / / / / / / / / / / / / / / / / / /
* | | | | | | | | | | | | | | | | | | | | Close #9450: mathjax: Load MathJax via "defer" strategyTakeshi KOMIYA2021-11-091-1/+1
| |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | To allow configure MathJax via static JS file, it should be loaded via "defer" strategy.
* | | | | | | | | | | | | | | | | | | | Merge pull request #9799 from tk0miya/9781_autodoc_preserve_hexadecimalTakeshi KOMIYA2021-11-011-5/+33
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ |/| | | | | | | | | | | | | | | | | | | Fix #9781: autodoc_preserve_defaults does not support hexadecimal
| * | | | | | | | | | | | | | | | | | | Fix #9781: autodoc_preserve_defaults does not support hexadecimalTakeshi KOMIYA2021-10-311-5/+33
| | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ | |/| | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | rename intersphinx_disabled_{refs -> reftypes}Jakob Lykke Andersen2021-10-311-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | And change format for domains to {name}:*
* | | | | | | | | | | | | | | | | | | intersphinx_disabled_refs, hard-code honor_disabled_refs in one more functionJakob Lykke Andersen2021-10-311-3/+2
| | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | ntersphinx_disabled_refs, type renameJakob Lykke Andersen2021-10-311-2/+2
| | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | intersphinx_disabled_refs, rename 'all' to '*'Jakob Lykke Andersen2021-10-311-1/+1
| | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | Generalize to disable specific refs as well.Jakob Lykke Andersen2021-10-311-15/+24
| | | | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | | Add intersphinx_disabled_domainsJakob Lykke Andersen2021-10-311-11/+28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes sphinx-doc/sphinx#2068 Replaces sphinx-doc/sphinx#8981
* | | | | | | | | | | | | | | | | | | Intersphinx, refactoringJakob Lykke Andersen2021-10-311-95/+178
|/ / / / / / / / / / / / / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Also, when a reference is unresolved, don't strip the inventory prefix.
* | | | | | | | | | | | | | | | | | Merge pull request #9764 from tk0miya/9752_annotated_slots_attributeTakeshi KOMIYA2021-10-271-3/+11
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fix #9752: autodoc: Failed to detect type annotation for slots attribute
| * | | | | | | | | | | | | | | | | | Fix #9752: autodoc: Failed to detect type annotation for slots attributeTakeshi KOMIYA2021-10-231-3/+11
| | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ | |/| | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | | Support docutils-0.18: Consume iterator of Element.traverse()Takeshi KOMIYA2021-10-274-5/+5
|/ / / / / / / / / / / / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since 0.18, Element.traverse() returns an iterator instead of intermediate object. As a result, the return value is always considered as truthy value. And it becomes fragile when the caller modifies the doctree on the loop.
* | | | | | | | | | | | | | | | | Merge branch '4.x' into 9607_incorrect_orig_basesTakeshi KOMIYA2021-09-273-7/+10
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Merge branch '4.x' into 9657_qualname_of_mockTakeshi KOMIYA2021-09-272-6/+7
| |\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \
| | * | | | | | | | | | | | | | | | | Fix #9651: autodoc_typehints_description_target was confused by :returns:Takeshi KOMIYA2021-09-261-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It only checks the existence of `:return:` field. And it does not check `:returns:` field. It causes the absence of return types.
| | * | | | | | | | | | | | | | | | | Fix #9655: autodoc: mocked object having doc comment is warned unexpectedlyTakeshi KOMIYA2021-09-241-4/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A warning for mocked object should not be emitted if it has doc comment.
| * | | | | | | | | | | | | | | | | | Fix #9657: autodoc: basecls for a subclass of mocked object is incorrectTakeshi KOMIYA2021-09-211-1/+3
| |/ / / / / / / / / / / / / / / / /
* | | | | | | | | | | | | | | | | | Fix #9607: autodoc: Incorrect base class detectionTakeshi KOMIYA2021-09-201-1/+1
|/ / / / / / / / / / / / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In case of the descendants of generic class, the value of obj.__orig_bases__ is incorrect because it returns original base arguments for the child of the generic class instead of the target class itself. This uses obj.__dict__ to get the correct __orig_bases__ information.
* | | | | | | | | | | | | | | | | Merge pull request #9644 from xmo-odoo/fix-sourcename-broken-getattrTakeshi KOMIYA2021-09-181-2/+2
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Protect `sphinx.ext.autodoc.get_sourcename` against misbehaving `__getattr__`
| * | | | | | | | | | | | | | | | | Protect get_sourcename against misbehaving `__getattr__`Xavier Morel2021-09-171-2/+2
| | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ | |/| | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | Merge pull request #9640 from tk0miya/9639_support_asyncgenfunctionTakeshi KOMIYA2021-09-181-2/+2
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Close #9639: autodoc: Support asynchronous generator functions
| * | | | | | | | | | | | | | | | | Close #9639: autodoc: Support asynchronous generator functionsTakeshi KOMIYA2021-09-171-2/+2
| |/ / / / / / / / / / / / / / / /
* | | | | | | | | | | | | | | | | Fix #9630: autosummary: Failed to build summary table if primary_domain is ↵Takeshi KOMIYA2021-09-141-2/+2
|/ / / / / / / / / / / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | not 'py' Autosummary generates reST code that uses raw `:obj:` xrefs to refer the python objects in the summary table. But they're fragile because they assume the primary_domain=='py'. This adds `:py:` prefix to these xrefs to make them robust.
* | | | | | | | | | | | | | | | Merge pull request #9616 from jdufresne/fix-urlTakeshi KOMIYA2021-09-113-5/+5
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | |_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ |/| | | | | | | | | | | | | | | Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g
| * | | | | | | | | | | | | | | Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|gJon Dufresne2021-09-063-5/+5
| | |_|_|_|_|_|_|_|_|_|_|_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | https://sphinx-doc.org is unreachable, but is linked from the PyPI page: https://pypi.org/project/Sphinx/. Switch to https://www.sphinx-doc.org/ instead.
* | | | | | | | | | | | | | | Fix typos discovered by codespellChristian Clauss2021-09-082-3/+3
|/ / / / / / / / / / / / / /
* | | | | | | | | | | | | | Fix #9600: autosummary: Typehints including commas confuses autosummaryTakeshi KOMIYA2021-09-041-1/+25
| | | | | | | | | | | | | |
View Lorry Controller Status