From cc7d86cf84e70e67b856170f73bd44eab8d29063 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 14 Apr 2020 00:10:02 +0900 Subject: [PATCH 01/24] refactor: autodoc: Use ENUM to autoclass_content --- sphinx/ext/autodoc/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index cfca54225..f44d2a893 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1755,7 +1755,7 @@ def setup(app: Sphinx) -> Dict[str, Any]: app.add_autodocumenter(InstanceAttributeDocumenter) app.add_autodocumenter(SlotsAttributeDocumenter) - app.add_config_value('autoclass_content', 'class', True) + app.add_config_value('autoclass_content', 'class', True, ENUM('both', 'class', 'init')) app.add_config_value('autodoc_member_order', 'alphabetic', True) app.add_config_value('autodoc_default_flags', [], True) app.add_config_value('autodoc_default_options', {}, True) From 711c041d8f2416f0edfb7ed90566f26b24e14d16 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 14 Apr 2020 00:07:59 +0900 Subject: [PATCH 02/24] autodoc: Remove autodoc_default_flags (no longer used) --- sphinx/ext/autodoc/__init__.py | 1 - 1 file changed, 1 deletion(-) diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index cfca54225..9c4b76ada 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1757,7 +1757,6 @@ def setup(app: Sphinx) -> Dict[str, Any]: app.add_config_value('autoclass_content', 'class', True) app.add_config_value('autodoc_member_order', 'alphabetic', True) - app.add_config_value('autodoc_default_flags', [], True) app.add_config_value('autodoc_default_options', {}, True) app.add_config_value('autodoc_docstring_signature', True, True) app.add_config_value('autodoc_mock_imports', [], True) From b14f9d7482f250ac86da9934647845912f38db5c Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Wed, 8 Apr 2020 22:32:54 +0200 Subject: [PATCH 03/24] Add globaltoc_collapse and globaltoc_includehidden options --- sphinx/themes/basic/globaltoc.html | 2 +- sphinx/themes/basic/theme.conf | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/sphinx/themes/basic/globaltoc.html b/sphinx/themes/basic/globaltoc.html index 59cab989b..2f16655cf 100644 --- a/sphinx/themes/basic/globaltoc.html +++ b/sphinx/themes/basic/globaltoc.html @@ -8,4 +8,4 @@ :license: BSD, see LICENSE for details. #}

{{ _('Table of Contents') }}

-{{ toctree() }} +{{ toctree(includehidden=theme_globaltoc_includehidden, collapse=theme_globaltoc_collapse) }} diff --git a/sphinx/themes/basic/theme.conf b/sphinx/themes/basic/theme.conf index df02a5aec..3c289d5dc 100644 --- a/sphinx/themes/basic/theme.conf +++ b/sphinx/themes/basic/theme.conf @@ -10,3 +10,5 @@ sidebarwidth = 230 body_min_width = 450 body_max_width = 800 navigation_with_keys = False +globaltoc_collapse = true +globaltoc_includehidden = false From c17f00c7a26975d09f1c3d3617b36e99aa0a2aeb Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Mon, 13 Apr 2020 19:22:17 +0200 Subject: [PATCH 04/24] DOC: globaltoc_collapse, globaltoc_includehidden --- doc/usage/theming.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/usage/theming.rst b/doc/usage/theming.rst index 5ed9f1f1b..e9d57abbb 100644 --- a/doc/usage/theming.rst +++ b/doc/usage/theming.rst @@ -155,6 +155,21 @@ These themes are: previous/next page using the keyboard's left and right arrows. Defaults to ``False``. + .. versionadded:: 3.1 + + The following options: + + - **globaltoc_collapse** (true or false): Only expand subsections + of the current document in ``globaltoc.html`` + (see :confval:`html_sidebars`). + Defaults to ``True``. + + - **globaltoc_includehidden** (true or false): Show even those + subsections in ``globaltoc.html`` (see :confval:`html_sidebars`) + which have been included with the ``:hidden:`` flag of the + :rst:dir:`toctree` directive. + Defaults to ``False``. + **alabaster** `Alabaster theme`_ is a modified "Kr" Sphinx theme from @kennethreitz (especially as used in his Requests project), which was itself originally From 0f7b2abdd8450078d117a44c65eecb09d8b29fe0 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Tue, 14 Apr 2020 16:08:26 +0200 Subject: [PATCH 05/24] Add right margin to footnote/citation labels --- sphinx/themes/basic/static/basic.css_t | 1 + 1 file changed, 1 insertion(+) diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t index e72db1249..4b15fce70 100644 --- a/sphinx/themes/basic/static/basic.css_t +++ b/sphinx/themes/basic/static/basic.css_t @@ -506,6 +506,7 @@ li > p:last-child { dl.footnote > dt, dl.citation > dt { float: left; + margin-right: 0.5em; } dl.footnote > dd, From 90c861d7f366972d04470ac4f65669f36e8ca3be Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Tue, 14 Apr 2020 17:59:33 +0200 Subject: [PATCH 06/24] basic theme: CSS spacing for code blocks with captions and line numbers --- sphinx/themes/basic/static/basic.css_t | 39 ++++++++++++++++++++------ 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t index e72db1249..08a3ad980 100644 --- a/sphinx/themes/basic/static/basic.css_t +++ b/sphinx/themes/basic/static/basic.css_t @@ -645,21 +645,47 @@ span.pre { } td.linenos pre { - padding: 5px 0px; border: 0; background-color: transparent; color: #aaa; } table.highlighttable { - margin-left: 0.5em; + display: block; + margin: 1em 0; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; } table.highlighttable td { - padding: 0 0.5em 0 0.5em; + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding: 0 0.5em; +} + +table.highlighttable td.code { + overflow: hidden; +} + +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div > table.highlighttable { + margin-top: 0; } div.code-block-caption { + margin-top: 1em; padding: 2px 5px; font-size: small; } @@ -672,6 +698,7 @@ div.code-block-caption + div > div.highlight > pre { margin-top: 0; } +table.highlighttable td.linenos, div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ user-select: none; } @@ -685,11 +712,7 @@ div.code-block-caption span.caption-text { } div.literal-block-wrapper { - padding: 1em 1em 0; -} - -div.literal-block-wrapper div.highlight { - margin: 0; + margin: 1em 0; } code.descname { From c795793d41d7ae0d13f2ab4ab5acf95f0e6551ec Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Tue, 14 Apr 2020 19:20:06 +0200 Subject: [PATCH 07/24] FIXUP: code blocks: full-width highlighted lines --- sphinx/themes/basic/static/basic.css_t | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t index 08a3ad980..72864bffd 100644 --- a/sphinx/themes/basic/static/basic.css_t +++ b/sphinx/themes/basic/static/basic.css_t @@ -673,9 +673,14 @@ table.highlighttable td.linenos { } table.highlighttable td.code { + flex: 1; overflow: hidden; } +.highlight .hll { + display: block; +} + table.highlighttable pre { margin: 0; } From 57bd6bc37cf0e7afbceb7e3e058b8ddf5222097c Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Tue, 14 Apr 2020 19:48:47 +0200 Subject: [PATCH 08/24] basic theme: Avoid clashes between sidebar and other blocks --- sphinx/themes/basic/static/basic.css_t | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t index e72db1249..c9038fea7 100644 --- a/sphinx/themes/basic/static/basic.css_t +++ b/sphinx/themes/basic/static/basic.css_t @@ -326,6 +326,10 @@ p.sidebar-title { font-weight: bold; } +div.admonition, div.topic, div.sidebar, pre { + clear: both; +} + /* -- topics ---------------------------------------------------------------- */ div.topic { From ae9ae3e749bbc633365256915802615f0f108147 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Tue, 14 Apr 2020 20:03:22 +0200 Subject: [PATCH 09/24] FIXUP: sidebar: only clear "right" --- sphinx/themes/basic/static/basic.css_t | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t index c9038fea7..8b0558e9a 100644 --- a/sphinx/themes/basic/static/basic.css_t +++ b/sphinx/themes/basic/static/basic.css_t @@ -320,13 +320,14 @@ div.sidebar { background-color: #ffe; width: 40%; float: right; + clear: right } p.sidebar-title { font-weight: bold; } -div.admonition, div.topic, div.sidebar, pre { +div.admonition, div.topic, pre { clear: both; } From 19d5d8d75cf484cc03e8d80b2a255241fb1d793b Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 15 Apr 2020 02:21:55 +0900 Subject: [PATCH 10/24] Fix #7477: imgconverter: Invoke "magick convert" command on Windows --- CHANGES | 2 ++ doc/usage/extensions/imgconverter.rst | 12 ++++++++++++ sphinx/ext/imgconverter.py | 14 ++++++++++++-- 3 files changed, 26 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index f671f7313..5d5d88ae6 100644 --- a/CHANGES +++ b/CHANGES @@ -7,6 +7,8 @@ Dependencies Incompatible changes -------------------- +* #7477: imgconverter: Invoke "magick convert" command by default on Windows + Deprecated ---------- diff --git a/doc/usage/extensions/imgconverter.rst b/doc/usage/extensions/imgconverter.rst index 5799fc3b3..9c742d059 100644 --- a/doc/usage/extensions/imgconverter.rst +++ b/doc/usage/extensions/imgconverter.rst @@ -34,7 +34,19 @@ Configuration A path to :command:`convert` command. By default, the imgconverter uses the command from search paths. + On windows platform, :command:`magick` command is used by default. + + .. versionchanged:: 3.1 + + Use :command:`magick` command by default on windows + .. confval:: image_converter_args Additional command-line arguments to give to :command:`convert`, as a list. The default is an empty list ``[]``. + + On windows platform, it defaults to ``["convert"]``. + + .. versionchanged:: 3.1 + + Use ``["convert"]`` by default on windows diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py index 3af93b642..bf4b9b9d1 100644 --- a/sphinx/ext/imgconverter.py +++ b/sphinx/ext/imgconverter.py @@ -9,6 +9,7 @@ """ import subprocess +import sys from subprocess import CalledProcessError, PIPE from typing import Any, Dict @@ -74,8 +75,17 @@ class ImagemagickConverter(ImageConverter): def setup(app: Sphinx) -> Dict[str, Any]: app.add_post_transform(ImagemagickConverter) - app.add_config_value('image_converter', 'convert', 'env') - app.add_config_value('image_converter_args', [], 'env') + if sys.platform == 'win32': + # On Windows, we use Imagemagik v7 by default to avoid the trouble for + # convert.exe bundled with Windows. + app.add_config_value('image_converter', 'magick', 'env') + app.add_config_value('image_converter_args', ['convert'], 'env') + else: + # On other platform, we use Imagemagick v6 by default. Especially, + # Debian/Ubuntu are still based of v6. So we can't use "magick" command + # for these platforms. + app.add_config_value('image_converter', 'convert', 'env') + app.add_config_value('image_converter_args', [], 'env') return { 'version': 'builtin', From a201e5a2f02a5640b0eb27190d62d9c1737d05f7 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 15 Apr 2020 23:27:51 +0900 Subject: [PATCH 11/24] Update CHANGES for PR #7481 --- CHANGES | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES b/CHANGES index f671f7313..8340073d6 100644 --- a/CHANGES +++ b/CHANGES @@ -22,6 +22,7 @@ Features added * C, added scope control directives, :rst:dir:`c:namespace`, :rst:dir:`c:namespace-push`, and :rst:dir:`c:namespace-pop`. * #7466: autosummary: headings in generated documents are not translated +* #7481: html theme: Add right margin to footnote/citation labels Bugs fixed ---------- From 5ed890122bfd6c5a0fa96774c074468922eeaea5 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 16 Apr 2020 01:27:48 +0900 Subject: [PATCH 12/24] Update CHANGES for PR #7482 --- CHANGES | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES b/CHANGES index 8453ad9b7..f44c9c487 100644 --- a/CHANGES +++ b/CHANGES @@ -25,6 +25,7 @@ Features added :rst:dir:`c:namespace-push`, and :rst:dir:`c:namespace-pop`. * #7466: autosummary: headings in generated documents are not translated * #7481: html theme: Add right margin to footnote/citation labels +* #7482: html theme: CSS spacing for code blocks with captions and line numbers Bugs fixed ---------- From 3baa6e09e2c488a29c2d6d18172aa47422dc4f1c Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Wed, 15 Apr 2020 21:02:41 +0200 Subject: [PATCH 13/24] FIXUP: move "versionadded" --- doc/usage/theming.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/usage/theming.rst b/doc/usage/theming.rst index e9d57abbb..0aae78718 100644 --- a/doc/usage/theming.rst +++ b/doc/usage/theming.rst @@ -155,21 +155,21 @@ These themes are: previous/next page using the keyboard's left and right arrows. Defaults to ``False``. - .. versionadded:: 3.1 - - The following options: - - **globaltoc_collapse** (true or false): Only expand subsections of the current document in ``globaltoc.html`` (see :confval:`html_sidebars`). Defaults to ``True``. + .. versionadded:: 3.1 + - **globaltoc_includehidden** (true or false): Show even those subsections in ``globaltoc.html`` (see :confval:`html_sidebars`) which have been included with the ``:hidden:`` flag of the :rst:dir:`toctree` directive. Defaults to ``False``. + .. versionadded:: 3.1 + **alabaster** `Alabaster theme`_ is a modified "Kr" Sphinx theme from @kennethreitz (especially as used in his Requests project), which was itself originally From 2530c3755a5834139331a03ea1b93796c8444c5f Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 16 Apr 2020 23:12:39 +0900 Subject: [PATCH 14/24] Update CHANGES for PR #7443 --- CHANGES | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGES b/CHANGES index f44c9c487..6d3ab6e1e 100644 --- a/CHANGES +++ b/CHANGES @@ -26,6 +26,9 @@ Features added * #7466: autosummary: headings in generated documents are not translated * #7481: html theme: Add right margin to footnote/citation labels * #7482: html theme: CSS spacing for code blocks with captions and line numbers +* #7443: Add new options ``globaltoc_collapse`` and ``globaltoc_includehidden`` + to control the behavior of globaltoc in sidebar + Bugs fixed ---------- From 57fe9ddc5aac53f51ba3eb25a661f3bdd49cb832 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Thu, 16 Apr 2020 17:19:07 +0200 Subject: [PATCH 15/24] FIXUP missing semicolon --- sphinx/themes/basic/static/basic.css_t | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t index 8b0558e9a..d56b8f72a 100644 --- a/sphinx/themes/basic/static/basic.css_t +++ b/sphinx/themes/basic/static/basic.css_t @@ -320,7 +320,7 @@ div.sidebar { background-color: #ffe; width: 40%; float: right; - clear: right + clear: right; } p.sidebar-title { From 92671774285336d9d96455efb501db38f1ea910e Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 17 Apr 2020 01:49:54 +0900 Subject: [PATCH 16/24] Update CHANGES for PR #7484 --- CHANGES | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES b/CHANGES index 6d3ab6e1e..6c811ca29 100644 --- a/CHANGES +++ b/CHANGES @@ -28,6 +28,7 @@ Features added * #7482: html theme: CSS spacing for code blocks with captions and line numbers * #7443: Add new options ``globaltoc_collapse`` and ``globaltoc_includehidden`` to control the behavior of globaltoc in sidebar +* #7484: html theme: Avoid clashes between sidebar and other blocks Bugs fixed From 574f448b634318d7e786fc45b8b42608b2b888ca Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 17 Apr 2020 01:50:30 +0900 Subject: [PATCH 17/24] Update CHANGES --- CHANGES | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index 6c811ca29..a5ec99e12 100644 --- a/CHANGES +++ b/CHANGES @@ -26,8 +26,9 @@ Features added * #7466: autosummary: headings in generated documents are not translated * #7481: html theme: Add right margin to footnote/citation labels * #7482: html theme: CSS spacing for code blocks with captions and line numbers -* #7443: Add new options ``globaltoc_collapse`` and ``globaltoc_includehidden`` - to control the behavior of globaltoc in sidebar +* #7443: html theme: Add new options :confval:`globaltoc_collapse` and + :confval:`globaltoc_includehidden` to control the behavior of globaltoc in + sidebar * #7484: html theme: Avoid clashes between sidebar and other blocks From 18a84d29fd6c3c2d6ab45d336fb18542c820cdbf Mon Sep 17 00:00:00 2001 From: Eric Wieser Date: Thu, 16 Apr 2020 18:17:24 +0100 Subject: [PATCH 18/24] Deduplicate some code in `pycode.ast` --- sphinx/pycode/ast.py | 37 +++++++++++++++---------------------- 1 file changed, 15 insertions(+), 22 deletions(-) diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py index fb2a7152d..c885db494 100644 --- a/sphinx/pycode/ast.py +++ b/sphinx/pycode/ast.py @@ -9,7 +9,7 @@ """ import sys -from typing import Dict, List, Type +from typing import Dict, List, Type, Optional if sys.version_info > (3, 8): import ast @@ -125,6 +125,17 @@ def unparse(node: ast.AST) -> str: raise NotImplementedError('Unable to parse %s object' % type(node).__name__) +def _unparse_arg(arg: ast.arg, default: Optional[ast.AST]) -> str: + """Unparse a single argument to a string.""" + name = unparse(arg) + if default: + if arg.annotation: + name += " = %s" % unparse(default) + else: + name += "=%s" % unparse(default) + return name + + def unparse_arguments(node: ast.arguments) -> str: """Unparse an arguments to string.""" defaults = list(node.defaults) @@ -143,25 +154,13 @@ def unparse_arguments(node: ast.arguments) -> str: args = [] # type: List[str] if hasattr(node, "posonlyargs"): # for py38+ for i, arg in enumerate(node.posonlyargs): # type: ignore - name = unparse(arg) - if defaults[i]: - if arg.annotation: - name += " = %s" % unparse(defaults[i]) - else: - name += "=%s" % unparse(defaults[i]) - args.append(name) + args.append(_unparse_arg(arg, defaults[i])) if node.posonlyargs: # type: ignore args.append('/') for i, arg in enumerate(node.args): - name = unparse(arg) - if defaults[i + posonlyargs]: - if arg.annotation: - name += " = %s" % unparse(defaults[i + posonlyargs]) - else: - name += "=%s" % unparse(defaults[i + posonlyargs]) - args.append(name) + args.append(_unparse_arg(arg, defaults[i + posonlyargs])) if node.vararg: args.append("*" + unparse(node.vararg)) @@ -169,13 +168,7 @@ def unparse_arguments(node: ast.arguments) -> str: if node.kwonlyargs and not node.vararg: args.append('*') for i, arg in enumerate(node.kwonlyargs): - name = unparse(arg) - if kw_defaults[i]: - if arg.annotation: - name += " = %s" % unparse(kw_defaults[i]) - else: - name += "=%s" % unparse(kw_defaults[i]) - args.append(name) + args.append(_unparse_arg(arg, kw_defaults[i])) if node.kwarg: args.append("**" + unparse(node.kwarg)) From 07902d3298635a2cd892336e1831eb0361b4ea46 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Mon, 13 Apr 2020 19:31:51 +0200 Subject: [PATCH 19/24] Relbar breadcrumb should contain current page --- sphinx/themes/basic/layout.html | 1 + 1 file changed, 1 insertion(+) diff --git a/sphinx/themes/basic/layout.html b/sphinx/themes/basic/layout.html index 0ab2afe35..f5961e389 100644 --- a/sphinx/themes/basic/layout.html +++ b/sphinx/themes/basic/layout.html @@ -42,6 +42,7 @@ {%- for parent in parents %}
  • {{ parent.title }}{{ reldelim1 }}
    • {%- endfor %} +
  • {{ title }}
    • {%- block relbaritems %} {% endblock %} From 224a3435b92613b0345390a3323483abd2e28ebf Mon Sep 17 00:00:00 2001 From: Jan Babst Date: Wed, 15 Apr 2020 20:17:06 +0200 Subject: [PATCH 20/24] C++, fix spacing issue in east-const notation --- sphinx/domains/cpp.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 79b6b9b03..aba487d07 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -2062,12 +2062,15 @@ class ASTDeclSpecs(ASTBase): if self.trailingTypeSpec: if addSpace: signode += nodes.Text(' ') + numChildren = len(signode) self.trailingTypeSpec.describe_signature(signode, mode, env, symbol=symbol) - numChildren = len(signode) - self.rightSpecs.describe_signature(signode) - if len(signode) != numChildren: - signode += nodes.Text(' ') + addSpace = len(signode) != numChildren + + if len(str(self.rightSpecs)) > 0: + if addSpace: + signode += nodes.Text(' ') + self.rightSpecs.describe_signature(signode) # Declarator From 9e6e45877078d1ff2f9835901caea34761bb9f04 Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Fri, 17 Apr 2020 15:04:33 +0200 Subject: [PATCH 21/24] Updated changes --- CHANGES | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES b/CHANGES index 93c06e571..04646ca5a 100644 --- a/CHANGES +++ b/CHANGES @@ -21,6 +21,7 @@ Bugs fixed * #7461: py domain: fails with IndexError for empty tuple in type annotation * #7461: autodoc: empty tuple in type annotation is not shown correctly +* C++, fix spacing issue in east-const declarations. Testing -------- From 0b0838e503e118228143700bd64094a4d0f90e2b Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 17 Apr 2020 22:49:50 +0900 Subject: [PATCH 22/24] Update CHANGES for PR #7476 --- CHANGES | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index a5ec99e12..5851b4622 100644 --- a/CHANGES +++ b/CHANGES @@ -30,7 +30,7 @@ Features added :confval:`globaltoc_includehidden` to control the behavior of globaltoc in sidebar * #7484: html theme: Avoid clashes between sidebar and other blocks - +* #7476: html theme: Relbar breadcrumb should contain current page Bugs fixed ---------- From fc78f09441ebfe2c3b3be693f77c2702522a33c0 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Fri, 17 Apr 2020 17:01:48 +0200 Subject: [PATCH 23/24] DOC: Use html_baseurl --- doc/_themes/sphinx13/layout.html | 5 ----- doc/conf.py | 1 + 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/doc/_themes/sphinx13/layout.html b/doc/_themes/sphinx13/layout.html index 8d1b04a14..e3bb37dce 100644 --- a/doc/_themes/sphinx13/layout.html +++ b/doc/_themes/sphinx13/layout.html @@ -13,11 +13,6 @@ {% block sidebar1 %}{{ sidebar() }}{% endblock %} {% block sidebar2 %}{% endblock %} -{% block linktags %} -{{ super() }} - -{% endblock %} - {% block extrahead %} diff --git a/doc/conf.py b/doc/conf.py index 77d2a577a..681fdc449 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -27,6 +27,7 @@ html_static_path = ['_static'] html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']} html_additional_pages = {'index': 'index.html'} html_use_opensearch = 'http://sphinx-doc.org' +html_baseurl = 'https://www.sphinx-doc.org/en/master/' htmlhelp_basename = 'Sphinxdoc' From ffb1ca3aaafe86b6bc44fe28e4000477e97ba3e8 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 18 Apr 2020 19:53:18 +0900 Subject: [PATCH 24/24] test: Add a docstring to avoid an error on py39a5+ --- tests/roots/test-ext-autodoc/target/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/roots/test-ext-autodoc/target/__init__.py b/tests/roots/test-ext-autodoc/target/__init__.py index e28eeef8a..b6684ee85 100644 --- a/tests/roots/test-ext-autodoc/target/__init__.py +++ b/tests/roots/test-ext-autodoc/target/__init__.py @@ -145,6 +145,8 @@ First line of docstring class StrRepr(str): + """docstring""" + def __repr__(self): return self