Dependencies: update requirement sphinx~=4.0

docs/source/nitpick-exceptions

@@ -29,6 +29,9 @@ py:class TransactionType
 py:class ReturnType
 py:class function
 py:class traceback
+py:class ExternalType
+py:class TypeDecorator
+py:class UserDefinedType
 py:class a
 py:class c
 py:class d

pyproject.toml

@@ -78,11 +78,11 @@ rest = [
 docs = [
     "docutils==0.15.2",
     "pygments~=2.5",
-    "pydata-sphinx-theme~=0.6.3",
-    "sphinx~=3.2.1",
+    "pydata-sphinx-theme~=0.8.0",
+    "sphinx~=4.1",
     "sphinxcontrib-details-directive~=0.1.0",
-    "sphinx-panels~=0.5.0",
-    "sphinx-copybutton~=0.3.0",
+    "sphinx-panels~=0.6.0",
+    "sphinx-copybutton~=0.5.0",
     "sphinx-notfound-page~=0.5",
     "sphinxext-rediraffe~=0.2.4",
     "sphinx-sqlalchemy~=0.1.1"
@@ -125,7 +125,7 @@ tests = [
     "pympler~=0.9",
     "coverage<5.0",
     "sqlalchemy-utils~=0.37.2",
-    "sphinx~=3.2.1"
+    "sphinx~=4.1"
 ]
 bpython = [
     "bpython~=0.18.0"

requirements/requirements-py-3.10.txt

@@ -100,7 +100,7 @@ py==1.11.0
 py-cpuinfo==8.0.0
 PyCifRW==4.4.3
 pycparser==2.21
-pydata-sphinx-theme==0.6.3
+pydata-sphinx-theme==0.8.0
 Pygments==2.10.0
 pymatgen==2022.1.9
 Pympler==0.9
@@ -137,10 +137,10 @@ six==1.16.0
 snowballstemmer==2.2.0
 soupsieve==2.3.1
 spglib==1.16.1
-Sphinx==3.2.1
-sphinx-copybutton==0.3.3
+Sphinx==4.4.0
+sphinx-copybutton==0.5.0
 sphinx-notfound-page==0.8
-sphinx-panels==0.5.2
+sphinx-panels==0.6.0
 sphinx-sqlalchemy==0.1.1
 sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-details-directive==0.1.0

requirements/requirements-py-3.8.txt

@@ -101,7 +101,7 @@ py==1.11.0
 py-cpuinfo==8.0.0
 PyCifRW==4.4.3
 pycparser==2.21
-pydata-sphinx-theme==0.6.3
+pydata-sphinx-theme==0.8.0
 Pygments==2.10.0
 pymatgen==2022.0.16
 Pympler==0.9
@@ -139,10 +139,10 @@ six==1.16.0
 snowballstemmer==2.2.0
 soupsieve==2.3.1
 spglib==1.16.1
-Sphinx==3.2.1
-sphinx-copybutton==0.3.3
+Sphinx==4.4.0
+sphinx-copybutton==0.5.0
 sphinx-notfound-page==0.8
-sphinx-panels==0.5.2
+sphinx-panels==0.6.0
 sphinx-sqlalchemy==0.1.1
 sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-details-directive==0.1.0

requirements/requirements-py-3.9.txt

@@ -100,7 +100,7 @@ py==1.11.0
 py-cpuinfo==8.0.0
 PyCifRW==4.4.3
 pycparser==2.21
-pydata-sphinx-theme==0.6.3
+pydata-sphinx-theme==0.8.0
 Pygments==2.10.0
 pymatgen==2022.0.16
 Pympler==0.9
@@ -138,10 +138,10 @@ six==1.16.0
 snowballstemmer==2.2.0
 soupsieve==2.3.1
 spglib==1.16.1
-Sphinx==3.2.1
-sphinx-copybutton==0.3.3
+Sphinx==4.4.0
+sphinx-copybutton==0.5.0
 sphinx-notfound-page==0.8
-sphinx-panels==0.5.2
+sphinx-panels==0.6.0
 sphinx-sqlalchemy==0.1.1
 sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-details-directive==0.1.0

tests/sphinxext/reference_results/workchain.xml

@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE document PUBLIC "+/IDN docutils.sourceforge.net/DTD Docutils Generic/EN/XML" "http:/docutils.sourceforge.net/docs/ref/docutils.dtd">
 <!-- Generated by Docutils 0.15.2 -->
-<document source="/private/var/folders/t2/xbl15_3n4tsb1vr_ccmmtmbr0000gn/T/pytest-of-chrisjsewell/pytest-139/test_workchain_build0/workchain/index.rst">
+<document source="/tmp/pytest-of-sph/pytest-1/test_workchain_build0/workchain/index.rst" xmlns:c="https:/www.sphinx-doc.org/" xmlns:changeset="https:/www.sphinx-doc.org/" xmlns:citation="https:/www.sphinx-doc.org/" xmlns:cpp="https:/www.sphinx-doc.org/" xmlns:index="https:/www.sphinx-doc.org/" xmlns:js="https:/www.sphinx-doc.org/" xmlns:math="https:/www.sphinx-doc.org/" xmlns:py="https:/www.sphinx-doc.org/" xmlns:rst="https:/www.sphinx-doc.org/" xmlns:std="https:/www.sphinx-doc.org/">
     <section ids="sphinx-aiida-demo" names="sphinx-aiida\ demo">
         <title>sphinx-aiida demo</title>
         <paragraph>This is a demo documentation to show off the features of the <literal>sphinx-aiida</literal> extension.</paragraph>
         <compound classes="toctree-wrapper">
         </compound>
         <desc desctype="class" domain="py" noindex="False" objtype="class">
-            <desc_signature first="False" fullname="WorkChain"><desc_annotation xml:space="preserve">workchain</desc_annotation><desc_addname xml:space="preserve">demo_workchain.</desc_addname><desc_name xml:space="preserve">DemoWorkChain</desc_name></desc_signature>
+            <desc_signature classes="sig sig-object py sig sig-object" first="False" fullname="WorkChain"><desc_annotation xml:space="preserve">workchain</desc_annotation><desc_addname classes="sig-prename descclassname sig-prename descclassname" xml:space="preserve">demo_workchain.</desc_addname><desc_name classes="sig-name descname sig-name descname" xml:space="preserve">DemoWorkChain</desc_name></desc_signature>
             <desc_content>
                 <paragraph>
                         A demo workchain to show how the workchain auto-documentation works.
@@ -25,7 +25,7 @@ finalize</literal_block></paragraph>
         </desc>
         <paragraph>If you want to hide the inputs that are not stored as nodes in the database, use the <literal>:hide-unstored-inputs:</literal> option.</paragraph>
         <desc desctype="class" domain="py" noindex="False" objtype="class">
-            <desc_signature first="False" fullname="WorkChain"><desc_annotation xml:space="preserve">workchain</desc_annotation><desc_addname xml:space="preserve">demo_workchain.</desc_addname><desc_name xml:space="preserve">DemoWorkChain</desc_name></desc_signature>
+            <desc_signature classes="sig sig-object py sig sig-object" first="False" fullname="WorkChain"><desc_annotation xml:space="preserve">workchain</desc_annotation><desc_addname classes="sig-prename descclassname sig-prename descclassname" xml:space="preserve">demo_workchain.</desc_addname><desc_name classes="sig-name descname sig-name descname" xml:space="preserve">DemoWorkChain</desc_name></desc_signature>
             <desc_content>
                 <paragraph>
                         A demo workchain to show how the workchain auto-documentation works.
@@ -42,7 +42,7 @@ finalize</literal_block></paragraph>
         </desc>
         <paragraph>The namespaces can be set to expand by default, using the <literal>:expand-namespaces:</literal> option.</paragraph>
         <desc desctype="class" domain="py" noindex="False" objtype="class">
-            <desc_signature first="False" fullname="WorkChain"><desc_annotation xml:space="preserve">workchain</desc_annotation><desc_addname xml:space="preserve">demo_workchain.</desc_addname><desc_name xml:space="preserve">DemoWorkChain</desc_name></desc_signature>
+            <desc_signature classes="sig sig-object py sig sig-object" first="False" fullname="WorkChain"><desc_annotation xml:space="preserve">workchain</desc_annotation><desc_addname classes="sig-prename descclassname sig-prename descclassname" xml:space="preserve">demo_workchain.</desc_addname><desc_name classes="sig-name descname sig-name descname" xml:space="preserve">DemoWorkChain</desc_name></desc_signature>
             <desc_content>
                 <paragraph>
                         A demo workchain to show how the workchain auto-documentation works.
@@ -59,7 +59,7 @@ finalize</literal_block></paragraph>
         </desc>
         <paragraph>The following workchain checks that the directive works also when no outline is specified:</paragraph>
         <desc desctype="class" domain="py" noindex="False" objtype="class">
-            <desc_signature first="False" fullname="WorkChain"><desc_annotation xml:space="preserve">workchain</desc_annotation><desc_addname xml:space="preserve">demo_workchain.</desc_addname><desc_name xml:space="preserve">EmptyOutlineWorkChain</desc_name></desc_signature>
+            <desc_signature classes="sig sig-object py sig sig-object" first="False" fullname="WorkChain"><desc_annotation xml:space="preserve">workchain</desc_annotation><desc_addname classes="sig-prename descclassname sig-prename descclassname" xml:space="preserve">demo_workchain.</desc_addname><desc_name classes="sig-name descname sig-name descname" xml:space="preserve">EmptyOutlineWorkChain</desc_name></desc_signature>
             <desc_content>
                 <paragraph>
                         Here we check that the directive works even if the outline is empty.
@@ -73,13 +73,13 @@ finalize</literal_block></paragraph>
         <index entries="['pair',\ 'module;\ demo_workchain',\ 'module-demo_workchain',\ '',\ None]"></index>
         <paragraph>This module defines an example workchain for the aiida-workchain documentation directive.</paragraph>
         <index entries="['single',\ 'DemoWorkChain\ (class\ in\ demo_workchain)',\ 'demo_workchain.DemoWorkChain',\ '',\ None]"></index>
-        <desc classes="py" desctype="class" domain="py" noindex="False" objtype="class">
-            <desc_signature class="" fullname="DemoWorkChain" ids="demo_workchain.DemoWorkChain" module="demo_workchain"><desc_annotation xml:space="preserve">class </desc_annotation><desc_addname xml:space="preserve">demo_workchain.</desc_addname><desc_name xml:space="preserve">DemoWorkChain</desc_name><desc_parameterlist xml:space="preserve"><desc_parameter xml:space="preserve"><desc_sig_operator classes="o o">*</desc_sig_operator><desc_sig_name classes="n n">args</desc_sig_name><desc_sig_punctuation classes="p p">:</desc_sig_punctuation> <desc_sig_name classes="n n">Any</desc_sig_name></desc_parameter><desc_parameter xml:space="preserve"><desc_sig_operator classes="o o">**</desc_sig_operator><desc_sig_name classes="n n">kwargs</desc_sig_name><desc_sig_punctuation classes="p p">:</desc_sig_punctuation> <desc_sig_name classes="n n">Any</desc_sig_name></desc_parameter></desc_parameterlist></desc_signature>
+        <desc classes="py class" desctype="class" domain="py" noindex="False" objtype="class">
+            <desc_signature class="" classes="sig sig-object py sig sig-object" fullname="DemoWorkChain" ids="demo_workchain.DemoWorkChain" module="demo_workchain"><desc_annotation xml:space="preserve">class<desc_sig_space classes="w w">  </desc_sig_space></desc_annotation><desc_addname classes="sig-prename descclassname sig-prename descclassname" xml:space="preserve">demo_workchain.</desc_addname><desc_name classes="sig-name descname sig-name descname" xml:space="preserve">DemoWorkChain</desc_name><desc_parameterlist xml:space="preserve"><desc_parameter xml:space="preserve"><desc_sig_operator classes="o o">*</desc_sig_operator><desc_sig_name classes="n n">args</desc_sig_name><desc_sig_punctuation classes="p p">:</desc_sig_punctuation><desc_sig_space classes="w w">  </desc_sig_space><desc_sig_name classes="n n">Any</desc_sig_name></desc_parameter><desc_parameter xml:space="preserve"><desc_sig_operator classes="o o">**</desc_sig_operator><desc_sig_name classes="n n">kwargs</desc_sig_name><desc_sig_punctuation classes="p p">:</desc_sig_punctuation><desc_sig_space classes="w w">  </desc_sig_space><desc_sig_name classes="n n">Any</desc_sig_name></desc_parameter></desc_parameterlist></desc_signature>
             <desc_content>
                 <paragraph>A demo workchain to show how the workchain auto-documentation works.</paragraph>
                 <index entries="['single',\ 'define()\ (demo_workchain.DemoWorkChain\ class\ method)',\ 'demo_workchain.DemoWorkChain.define',\ '',\ None]"></index>
-                <desc classes="py" desctype="method" domain="py" noindex="False" objtype="method">
-                    <desc_signature class="DemoWorkChain" fullname="DemoWorkChain.define" ids="demo_workchain.DemoWorkChain.define" module="demo_workchain"><desc_annotation xml:space="preserve">classmethod </desc_annotation><desc_name xml:space="preserve">define</desc_name><desc_parameterlist xml:space="preserve"><desc_parameter xml:space="preserve"><desc_sig_name classes="n n">spec</desc_sig_name></desc_parameter></desc_parameterlist></desc_signature>
+                <desc classes="py method" desctype="method" domain="py" noindex="False" objtype="method">
+                    <desc_signature class="DemoWorkChain" classes="sig sig-object py sig sig-object" fullname="DemoWorkChain.define" ids="demo_workchain.DemoWorkChain.define" module="demo_workchain"><desc_annotation xml:space="preserve">classmethod<desc_sig_space classes="w w">  </desc_sig_space></desc_annotation><desc_name classes="sig-name descname sig-name descname" xml:space="preserve">define</desc_name><desc_parameterlist xml:space="preserve"><desc_parameter xml:space="preserve"><desc_sig_name classes="n n">spec</desc_sig_name></desc_parameter></desc_parameterlist></desc_signature>
                     <desc_content>
                         <paragraph>Define the specification of the process, including its inputs, outputs and known exit codes.</paragraph>
                         <paragraph>A <title_reference>metadata</title_reference> input namespace is defined, with optional ports that are not stored in the database.</paragraph>
@@ -88,13 +88,13 @@ finalize</literal_block></paragraph>
             </desc_content>
         </desc>
         <index entries="['single',\ 'EmptyOutlineWorkChain\ (class\ in\ demo_workchain)',\ 'demo_workchain.EmptyOutlineWorkChain',\ '',\ None]"></index>
-        <desc classes="py" desctype="class" domain="py" noindex="False" objtype="class">
-            <desc_signature class="" fullname="EmptyOutlineWorkChain" ids="demo_workchain.EmptyOutlineWorkChain" module="demo_workchain"><desc_annotation xml:space="preserve">class </desc_annotation><desc_addname xml:space="preserve">demo_workchain.</desc_addname><desc_name xml:space="preserve">EmptyOutlineWorkChain</desc_name><desc_parameterlist xml:space="preserve"><desc_parameter xml:space="preserve"><desc_sig_operator classes="o o">*</desc_sig_operator><desc_sig_name classes="n n">args</desc_sig_name><desc_sig_punctuation classes="p p">:</desc_sig_punctuation> <desc_sig_name classes="n n">Any</desc_sig_name></desc_parameter><desc_parameter xml:space="preserve"><desc_sig_operator classes="o o">**</desc_sig_operator><desc_sig_name classes="n n">kwargs</desc_sig_name><desc_sig_punctuation classes="p p">:</desc_sig_punctuation> <desc_sig_name classes="n n">Any</desc_sig_name></desc_parameter></desc_parameterlist></desc_signature>
+        <desc classes="py class" desctype="class" domain="py" noindex="False" objtype="class">
+            <desc_signature class="" classes="sig sig-object py sig sig-object" fullname="EmptyOutlineWorkChain" ids="demo_workchain.EmptyOutlineWorkChain" module="demo_workchain"><desc_annotation xml:space="preserve">class<desc_sig_space classes="w w">  </desc_sig_space></desc_annotation><desc_addname classes="sig-prename descclassname sig-prename descclassname" xml:space="preserve">demo_workchain.</desc_addname><desc_name classes="sig-name descname sig-name descname" xml:space="preserve">EmptyOutlineWorkChain</desc_name><desc_parameterlist xml:space="preserve"><desc_parameter xml:space="preserve"><desc_sig_operator classes="o o">*</desc_sig_operator><desc_sig_name classes="n n">args</desc_sig_name><desc_sig_punctuation classes="p p">:</desc_sig_punctuation><desc_sig_space classes="w w">  </desc_sig_space><desc_sig_name classes="n n">Any</desc_sig_name></desc_parameter><desc_parameter xml:space="preserve"><desc_sig_operator classes="o o">**</desc_sig_operator><desc_sig_name classes="n n">kwargs</desc_sig_name><desc_sig_punctuation classes="p p">:</desc_sig_punctuation><desc_sig_space classes="w w">  </desc_sig_space><desc_sig_name classes="n n">Any</desc_sig_name></desc_parameter></desc_parameterlist></desc_signature>
             <desc_content>
                 <paragraph>Here we check that the directive works even if the outline is empty.</paragraph>
                 <index entries="['single',\ 'define()\ (demo_workchain.EmptyOutlineWorkChain\ class\ method)',\ 'demo_workchain.EmptyOutlineWorkChain.define',\ '',\ None]"></index>
-                <desc classes="py" desctype="method" domain="py" noindex="False" objtype="method">
-                    <desc_signature class="EmptyOutlineWorkChain" fullname="EmptyOutlineWorkChain.define" ids="demo_workchain.EmptyOutlineWorkChain.define" module="demo_workchain"><desc_annotation xml:space="preserve">classmethod </desc_annotation><desc_name xml:space="preserve">define</desc_name><desc_parameterlist xml:space="preserve"><desc_parameter xml:space="preserve"><desc_sig_name classes="n n">spec</desc_sig_name></desc_parameter></desc_parameterlist></desc_signature>
+                <desc classes="py method" desctype="method" domain="py" noindex="False" objtype="method">
+                    <desc_signature class="EmptyOutlineWorkChain" classes="sig sig-object py sig sig-object" fullname="EmptyOutlineWorkChain.define" ids="demo_workchain.EmptyOutlineWorkChain.define" module="demo_workchain"><desc_annotation xml:space="preserve">classmethod<desc_sig_space classes="w w">  </desc_sig_space></desc_annotation><desc_name classes="sig-name descname sig-name descname" xml:space="preserve">define</desc_name><desc_parameterlist xml:space="preserve"><desc_parameter xml:space="preserve"><desc_sig_name classes="n n">spec</desc_sig_name></desc_parameter></desc_parameterlist></desc_signature>
                     <desc_content>
                         <paragraph>Define the specification of the process, including its inputs, outputs and known exit codes.</paragraph>
                         <paragraph>A <title_reference>metadata</title_reference> input namespace is defined, with optional ports that are not stored in the database.</paragraph>
@@ -103,11 +103,11 @@ finalize</literal_block></paragraph>
             </desc_content>
         </desc>
         <index entries="['single',\ 'NormalClass\ (class\ in\ demo_workchain)',\ 'demo_workchain.NormalClass',\ '',\ None]"></index>
-        <desc classes="py" desctype="class" domain="py" noindex="False" objtype="class">
-            <desc_signature class="" fullname="NormalClass" ids="demo_workchain.NormalClass" module="demo_workchain"><desc_annotation xml:space="preserve">class </desc_annotation><desc_addname xml:space="preserve">demo_workchain.</desc_addname><desc_name xml:space="preserve">NormalClass</desc_name></desc_signature>
+        <desc classes="py class" desctype="class" domain="py" noindex="False" objtype="class">
+            <desc_signature class="" classes="sig sig-object py sig sig-object" fullname="NormalClass" ids="demo_workchain.NormalClass" module="demo_workchain"><desc_annotation xml:space="preserve">class<desc_sig_space classes="w w">  </desc_sig_space></desc_annotation><desc_addname classes="sig-prename descclassname sig-prename descclassname" xml:space="preserve">demo_workchain.</desc_addname><desc_name classes="sig-name descname sig-name descname" xml:space="preserve">NormalClass</desc_name></desc_signature>
             <desc_content>
                 <paragraph>This is here to check that we didn’t break the regular autoclass.</paragraph>
             </desc_content>
         </desc>
     </section>
-</document>
+</document>