✨ NEW: Add autodoc2-summary directive (#10)

and improve `__all__` resolution
sphinx-extensions2 · Feb 28, 2023 · c62622c · c62622c
1 parent 812a350
commit c62622c
Show file tree

Hide file tree

Showing 48 changed files with 1,071 additions and 736 deletions.
diff --git a/docs/apidocs/aiida/aiida.common.rst b/docs/apidocs/aiida/aiida.common.rst
@@ -162,8 +162,6 @@ API
    .. py:method:: __dir__()
       :canonical: aiida.common.extendeddicts.AttributeDict.__dir__
 
-      .. autodoc2-docstring:: aiida.common.extendeddicts.AttributeDict.__dir__
-
 .. py:class:: CalcInfo(dictionary=None)
    :canonical: aiida.common.datastructures.CalcInfo
 
@@ -458,8 +456,6 @@ API
    .. py:method:: __dir__()
       :canonical: aiida.common.extendeddicts.FixedFieldsAttributeDict.__dir__
 
-      .. autodoc2-docstring:: aiida.common.extendeddicts.FixedFieldsAttributeDict.__dir__
-
 .. py:data:: GraphTraversalRule
    :canonical: aiida.common.links.GraphTraversalRule
    :value: None

diff --git a/docs/apidocs/aiida/aiida.engine.rst b/docs/apidocs/aiida/aiida.engine.rst
@@ -423,8 +423,6 @@ API
       :canonical: aiida.engine.processes.calcjobs.calcjob.CalcJob.node
       :type: aiida.orm.CalcJobNode
 
-      .. autodoc2-docstring:: aiida.engine.processes.calcjobs.calcjob.CalcJob.node
-
    .. py:method:: on_terminated() -> None
       :canonical: aiida.engine.processes.calcjobs.calcjob.CalcJob.on_terminated
 
@@ -1440,13 +1438,9 @@ API
    .. py:method:: __repr__()
       :canonical: aiida.engine.processes.builder.ProcessBuilderNamespace.__repr__
 
-      .. autodoc2-docstring:: aiida.engine.processes.builder.ProcessBuilderNamespace.__repr__
-
    .. py:method:: __dir__()
       :canonical: aiida.engine.processes.builder.ProcessBuilderNamespace.__dir__
 
-      .. autodoc2-docstring:: aiida.engine.processes.builder.ProcessBuilderNamespace.__dir__
-
    .. py:method:: __iter__()
       :canonical: aiida.engine.processes.builder.ProcessBuilderNamespace.__iter__
 
@@ -1475,8 +1469,6 @@ API
    .. py:method:: __delattr__(item)
       :canonical: aiida.engine.processes.builder.ProcessBuilderNamespace.__delattr__
 
-      .. autodoc2-docstring:: aiida.engine.processes.builder.ProcessBuilderNamespace.__delattr__
-
    .. py:method:: _recursive_merge(dictionary, key, value)
       :canonical: aiida.engine.processes.builder.ProcessBuilderNamespace._recursive_merge
 
@@ -1885,8 +1877,6 @@ API
       :canonical: aiida.engine.processes.workchains.workchain.WorkChain.node
       :type: aiida.orm.WorkChainNode
 
-      .. autodoc2-docstring:: aiida.engine.processes.workchains.workchain.WorkChain.node
-
    .. py:property:: ctx
       :canonical: aiida.engine.processes.workchains.workchain.WorkChain.ctx
       :type: aiida.common.extendeddicts.AttributeDict
@@ -1901,8 +1891,6 @@ API
    .. py:method:: load_instance_state(saved_state, load_context)
       :canonical: aiida.engine.processes.workchains.workchain.WorkChain.load_instance_state
 
-      .. autodoc2-docstring:: aiida.engine.processes.workchains.workchain.WorkChain.load_instance_state
-
    .. py:method:: on_run()
       :canonical: aiida.engine.processes.workchains.workchain.WorkChain.on_run
 

diff --git a/docs/apidocs/aiida/aiida.manage.rst b/docs/apidocs/aiida/aiida.manage.rst
@@ -357,8 +357,6 @@ API
    .. py:method:: __str__() -> str
       :canonical: aiida.manage.configuration.config.ConfigValidationError.__str__
 
-      .. autodoc2-docstring:: aiida.manage.configuration.config.ConfigValidationError.__str__
-
 .. py:data:: MIGRATIONS
    :canonical: aiida.manage.configuration.migrations.migrations.MIGRATIONS
    :value: ()
@@ -394,8 +392,6 @@ API
    .. py:method:: __str__() -> str
       :canonical: aiida.manage.configuration.options.Option.__str__
 
-      .. autodoc2-docstring:: aiida.manage.configuration.options.Option.__str__
-
    .. py:property:: name
       :canonical: aiida.manage.configuration.options.Option.name
       :type: str
@@ -616,8 +612,6 @@ API
    .. py:method:: __repr__() -> str
       :canonical: aiida.manage.configuration.profile.Profile.__repr__
 
-      .. autodoc2-docstring:: aiida.manage.configuration.profile.Profile.__repr__
-
    .. py:method:: copy()
       :canonical: aiida.manage.configuration.profile.Profile.copy
 

diff --git a/docs/apidocs/aiida/aiida.orm.rst b/docs/apidocs/aiida/aiida.orm.rst
@@ -483,8 +483,6 @@ API
    .. py:method:: initialize()
       :canonical: aiida.orm.nodes.data.array.array.ArrayData.initialize
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.array.array.ArrayData.initialize
-
    .. py:method:: delete_array(name)
       :canonical: aiida.orm.nodes.data.array.array.ArrayData.delete_array
 
@@ -577,8 +575,6 @@ API
    .. py:method:: __setattr__(name, value)
       :canonical: aiida.orm.utils.managers.AttributeManager.__setattr__
 
-      .. autodoc2-docstring:: aiida.orm.utils.managers.AttributeManager.__setattr__
-
    .. py:method:: __getitem__(name)
       :canonical: aiida.orm.utils.managers.AttributeManager.__getitem__
 
@@ -1458,8 +1454,6 @@ API
    .. py:method:: __str__()
       :canonical: aiida.orm.nodes.data.code.legacy.Code.__str__
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.code.legacy.Code.__str__
-
    .. py:method:: get_computer_label()
       :canonical: aiida.orm.nodes.data.code.legacy.Code.get_computer_label
 
@@ -1507,8 +1501,6 @@ API
    .. py:method:: _validate()
       :canonical: aiida.orm.nodes.data.code.legacy.Code._validate
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.code.legacy.Code._validate
-
    .. py:method:: validate_remote_exec_path()
       :canonical: aiida.orm.nodes.data.code.legacy.Code.validate_remote_exec_path
 
@@ -2986,13 +2978,9 @@ API
    .. py:method:: __repr__()
       :canonical: aiida.orm.nodes.data.structure.Kind.__repr__
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.structure.Kind.__repr__
-
    .. py:method:: __str__()
       :canonical: aiida.orm.nodes.data.structure.Kind.__str__
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.structure.Kind.__str__
-
 .. py:class:: KpointsData
    :canonical: aiida.orm.nodes.data.array.kpoints.KpointsData
 
@@ -3248,33 +3236,21 @@ API
    .. py:method:: __str__()
       :canonical: aiida.orm.nodes.data.list.List.__str__
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.list.List.__str__
-
    .. py:method:: __eq__(other)
       :canonical: aiida.orm.nodes.data.list.List.__eq__
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.list.List.__eq__
-
    .. py:method:: append(value)
       :canonical: aiida.orm.nodes.data.list.List.append
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.list.List.append
-
    .. py:method:: extend(value)
       :canonical: aiida.orm.nodes.data.list.List.extend
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.list.List.extend
-
    .. py:method:: insert(i, value)
       :canonical: aiida.orm.nodes.data.list.List.insert
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.list.List.insert
-
    .. py:method:: remove(value)
       :canonical: aiida.orm.nodes.data.list.List.remove
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.list.List.remove
-
    .. py:method:: pop(**kwargs)
       :canonical: aiida.orm.nodes.data.list.List.pop
 
@@ -3298,8 +3274,6 @@ API
    .. py:method:: reverse()
       :canonical: aiida.orm.nodes.data.list.List.reverse
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.list.List.reverse
-
    .. py:method:: get_list()
       :canonical: aiida.orm.nodes.data.list.List.get_list
 
@@ -3479,13 +3453,9 @@ API
    .. py:method:: __repr__() -> str
       :canonical: aiida.orm.nodes.node.Node.__repr__
 
-      .. autodoc2-docstring:: aiida.orm.nodes.node.Node.__repr__
-
    .. py:method:: __str__() -> str
       :canonical: aiida.orm.nodes.node.Node.__str__
 
-      .. autodoc2-docstring:: aiida.orm.nodes.node.Node.__str__
-
    .. py:method:: __copy__()
       :canonical: aiida.orm.nodes.node.Node.__copy__
 
@@ -3814,8 +3784,6 @@ API
    .. py:method:: __repr__()
       :canonical: aiida.orm.utils.managers.NodeLinksManager.__repr__
 
-      .. autodoc2-docstring:: aiida.orm.utils.managers.NodeLinksManager.__repr__
-
 .. py:class:: NodeRepository(node: aiida.orm.nodes.node.Node)
    :canonical: aiida.orm.nodes.repository.NodeRepository
 
@@ -4283,8 +4251,6 @@ API
    .. py:method:: __str__() -> str
       :canonical: aiida.orm.nodes.process.process.ProcessNode.__str__
 
-      .. autodoc2-docstring:: aiida.orm.nodes.process.process.ProcessNode.__str__
-
    .. py:method:: _updatable_attributes() -> typing.Tuple[str, ...]
       :canonical: aiida.orm.nodes.process.process.ProcessNode._updatable_attributes
 
@@ -4782,8 +4748,6 @@ API
    .. py:method:: _validate()
       :canonical: aiida.orm.nodes.data.remote.base.RemoteData._validate
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.remote.base.RemoteData._validate
-
    .. py:method:: get_authinfo()
       :canonical: aiida.orm.nodes.data.remote.base.RemoteData.get_authinfo
 
@@ -4915,13 +4879,9 @@ API
    .. py:method:: __repr__()
       :canonical: aiida.orm.nodes.data.structure.Site.__repr__
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.structure.Site.__repr__
-
    .. py:method:: __str__()
       :canonical: aiida.orm.nodes.data.structure.Site.__str__
 
-      .. autodoc2-docstring:: aiida.orm.nodes.data.structure.Site.__str__
-
 .. py:class:: Str
    :canonical: aiida.orm.nodes.data.str.Str
 

diff --git a/docs/apidocs/aiida/aiida.repository.rst b/docs/apidocs/aiida/aiida.repository.rst
@@ -185,8 +185,6 @@ API
       :canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.key_format
       :type: typing.Optional[str]
 
-      .. autodoc2-docstring:: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.key_format
-
    .. py:method:: initialise(**kwargs) -> None
       :canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.initialise
 
@@ -211,8 +209,6 @@ API
    .. py:method:: has_objects(keys: typing.List[str]) -> typing.List[bool]
       :canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.has_objects
 
-      .. autodoc2-docstring:: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.has_objects
-
    .. py:method:: open(key: str) -> typing.Iterator[typing.BinaryIO]
       :canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.open
 
@@ -221,18 +217,12 @@ API
    .. py:method:: iter_object_streams(keys: typing.List[str]) -> typing.Iterator[typing.Tuple[str, typing.BinaryIO]]
       :canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.iter_object_streams
 
-      .. autodoc2-docstring:: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.iter_object_streams
-
    .. py:method:: delete_objects(keys: typing.List[str]) -> None
       :canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.delete_objects
 
-      .. autodoc2-docstring:: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.delete_objects
-
    .. py:method:: list_objects() -> typing.Iterable[str]
       :canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.list_objects
 
-      .. autodoc2-docstring:: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.list_objects
-
    .. py:method:: get_object_hash(key: str) -> str
       :canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.get_object_hash
 
@@ -310,8 +300,6 @@ API
    .. py:method:: __repr__()
       :canonical: aiida.repository.common.File.__repr__
 
-      .. autodoc2-docstring:: aiida.repository.common.File.__repr__
-
 .. py:class:: FileType
    :canonical: aiida.repository.common.FileType
 
@@ -548,8 +536,6 @@ API
       :canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.key_format
       :type: str | None
 
-      .. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.key_format
-
    .. py:method:: initialise(**kwargs) -> None
       :canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.initialise
 
@@ -579,36 +565,22 @@ API
    .. py:method:: has_objects(keys: list[str]) -> list[bool]
       :canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.has_objects
 
-      .. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.has_objects
-
    .. py:method:: open(key: str) -> typing.Iterator[typing.BinaryIO]
       :canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.open
 
-      .. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.open
-
    .. py:method:: iter_object_streams(keys: list[str]) -> typing.Iterator[tuple[str, typing.BinaryIO]]
       :canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.iter_object_streams
 
-      .. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.iter_object_streams
-
    .. py:method:: delete_objects(keys: list[str]) -> None
       :canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.delete_objects
 
-      .. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.delete_objects
-
    .. py:method:: list_objects() -> typing.Iterable[str]
       :canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.list_objects
 
-      .. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.list_objects
-
    .. py:method:: maintain(dry_run: bool = False, live: bool = True, **kwargs) -> None
       :canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.maintain
       :abstractmethod:
 
-      .. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.maintain
-
    .. py:method:: get_info(detailed: bool = False, **kwargs) -> dict
       :canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.get_info
       :abstractmethod:
-
-      .. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.get_info
diff --git a/docs/apidocs/aiida/aiida.schedulers.rst b/docs/apidocs/aiida/aiida.schedulers.rst
@@ -363,8 +363,6 @@ API
    .. py:method:: __str__()
       :canonical: aiida.schedulers.scheduler.Scheduler.__str__
 
-      .. autodoc2-docstring:: aiida.schedulers.scheduler.Scheduler.__str__
-
    .. py:method:: preprocess_resources(resources, default_mpiprocs_per_machine=None)
       :canonical: aiida.schedulers.scheduler.Scheduler.preprocess_resources
       :classmethod:

diff --git a/docs/apidocs/aiida/aiida.tools.rst b/docs/apidocs/aiida/aiida.tools.rst
@@ -392,13 +392,9 @@ API
    .. py:method:: __repr__()
       :canonical: aiida.tools.data.orbital.orbital.Orbital.__repr__
 
-      .. autodoc2-docstring:: aiida.tools.data.orbital.orbital.Orbital.__repr__
-
    .. py:method:: __str__() -> str
       :canonical: aiida.tools.data.orbital.orbital.Orbital.__str__
 
-      .. autodoc2-docstring:: aiida.tools.data.orbital.orbital.Orbital.__str__
-
    .. py:method:: _validate_keys(input_dict)
       :canonical: aiida.tools.data.orbital.orbital.Orbital._validate_keys
 

diff --git a/docs/apidocs/aiida/aiida.transports.rst b/docs/apidocs/aiida/aiida.transports.rst
@@ -300,13 +300,9 @@ API
    .. py:method:: copyfile(remotesource, remotedestination, dereference=False)
       :canonical: aiida.transports.plugins.ssh.SshTransport.copyfile
 
-      .. autodoc2-docstring:: aiida.transports.plugins.ssh.SshTransport.copyfile
-
    .. py:method:: copytree(remotesource, remotedestination, dereference=False)
       :canonical: aiida.transports.plugins.ssh.SshTransport.copytree
 
-      .. autodoc2-docstring:: aiida.transports.plugins.ssh.SshTransport.copytree
-
    .. py:method:: copy(remotesource, remotedestination, dereference=False, recursive=True)
       :canonical: aiida.transports.plugins.ssh.SshTransport.copy
 
@@ -451,13 +447,9 @@ API
    .. py:method:: __repr__()
       :canonical: aiida.transports.transport.Transport.__repr__
 
-      .. autodoc2-docstring:: aiida.transports.transport.Transport.__repr__
-
    .. py:method:: __str__()
       :canonical: aiida.transports.transport.Transport.__str__
 
-      .. autodoc2-docstring:: aiida.transports.transport.Transport.__str__
-
    .. py:method:: set_logger_extra(logger_extra)
       :canonical: aiida.transports.transport.Transport.set_logger_extra