From 4d75f0dced431614d973f4cd9ea559dddd06990b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Melissa=20Weber=20Mendon=C3=A7a?= Date: Fri, 12 Apr 2024 15:25:38 -0300 Subject: [PATCH 1/2] Fixes display of inherited members of classes I inadvertently added a Jinja syntax error in gh-316. Also adds a comment to explain why this is necessary. --- docs/_templates/autosummary/class.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst index 36c17e81..08de4f5d 100644 --- a/docs/_templates/autosummary/class.rst +++ b/docs/_templates/autosummary/class.rst @@ -5,9 +5,11 @@ .. autoclass:: {{ objname }} :members: :show-inheritance: - {% if objname != "progress" %} - :inherited-members: - {% endif %} + {# These classes inherit docstrings from the raw qt source, which + generates rst syntax errors when building the docs #} + {% if objname not in ["progress", "cancelable_progress"] -%} + :inherited-members: + {%- endif %} {% block methods %} From 15a06505f8188033c0f8d700b4b4dfdf439b8a5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Melissa=20Weber=20Mendon=C3=A7a?= Date: Fri, 12 Apr 2024 15:57:01 -0300 Subject: [PATCH 2/2] Fix whitespace in template --- docs/_templates/autosummary/class.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst index 08de4f5d..58d91de8 100644 --- a/docs/_templates/autosummary/class.rst +++ b/docs/_templates/autosummary/class.rst @@ -5,8 +5,7 @@ .. autoclass:: {{ objname }} :members: :show-inheritance: - {# These classes inherit docstrings from the raw qt source, which - generates rst syntax errors when building the docs #} + {#- These classes inherit docstrings from the raw qt source, which generates rst syntax errors when building the docs #} {% if objname not in ["progress", "cancelable_progress"] -%} :inherited-members: {%- endif %}