Skip to content

Commit c62622c

Browse files
chrisjsewellchrisjsewell
authored
✨ NEW: Add autodoc2-summary directive (#10)
and improve `__all__` resolution
1 parent 812a350 commit c62622c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1071
-736
lines changed

‎docs/apidocs/aiida/aiida.common.rst‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,6 @@ API
162162
.. py:method:: __dir__()
163163
:canonical: aiida.common.extendeddicts.AttributeDict.__dir__
164164

165-
.. autodoc2-docstring:: aiida.common.extendeddicts.AttributeDict.__dir__
166-
167165
.. py:class:: CalcInfo(dictionary=None)
168166
:canonical: aiida.common.datastructures.CalcInfo
169167

@@ -458,8 +456,6 @@ API
458456
.. py:method:: __dir__()
459457
:canonical: aiida.common.extendeddicts.FixedFieldsAttributeDict.__dir__
460458

461-
.. autodoc2-docstring:: aiida.common.extendeddicts.FixedFieldsAttributeDict.__dir__
462-
463459
.. py:data:: GraphTraversalRule
464460
:canonical: aiida.common.links.GraphTraversalRule
465461
:value: None

‎docs/apidocs/aiida/aiida.engine.rst‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -423,8 +423,6 @@ API
423423
:canonical: aiida.engine.processes.calcjobs.calcjob.CalcJob.node
424424
:type: aiida.orm.CalcJobNode
425425

426-
.. autodoc2-docstring:: aiida.engine.processes.calcjobs.calcjob.CalcJob.node
427-
428426
.. py:method:: on_terminated() -> None
429427
:canonical: aiida.engine.processes.calcjobs.calcjob.CalcJob.on_terminated
430428

@@ -1440,13 +1438,9 @@ API
14401438
.. py:method:: __repr__()
14411439
:canonical: aiida.engine.processes.builder.ProcessBuilderNamespace.__repr__
14421440

1443-
.. autodoc2-docstring:: aiida.engine.processes.builder.ProcessBuilderNamespace.__repr__
1444-
14451441
.. py:method:: __dir__()
14461442
:canonical: aiida.engine.processes.builder.ProcessBuilderNamespace.__dir__
14471443

1448-
.. autodoc2-docstring:: aiida.engine.processes.builder.ProcessBuilderNamespace.__dir__
1449-
14501444
.. py:method:: __iter__()
14511445
:canonical: aiida.engine.processes.builder.ProcessBuilderNamespace.__iter__
14521446

@@ -1475,8 +1469,6 @@ API
14751469
.. py:method:: __delattr__(item)
14761470
:canonical: aiida.engine.processes.builder.ProcessBuilderNamespace.__delattr__
14771471

1478-
.. autodoc2-docstring:: aiida.engine.processes.builder.ProcessBuilderNamespace.__delattr__
1479-
14801472
.. py:method:: _recursive_merge(dictionary, key, value)
14811473
:canonical: aiida.engine.processes.builder.ProcessBuilderNamespace._recursive_merge
14821474

@@ -1885,8 +1877,6 @@ API
18851877
:canonical: aiida.engine.processes.workchains.workchain.WorkChain.node
18861878
:type: aiida.orm.WorkChainNode
18871879

1888-
.. autodoc2-docstring:: aiida.engine.processes.workchains.workchain.WorkChain.node
1889-
18901880
.. py:property:: ctx
18911881
:canonical: aiida.engine.processes.workchains.workchain.WorkChain.ctx
18921882
:type: aiida.common.extendeddicts.AttributeDict
@@ -1901,8 +1891,6 @@ API
19011891
.. py:method:: load_instance_state(saved_state, load_context)
19021892
:canonical: aiida.engine.processes.workchains.workchain.WorkChain.load_instance_state
19031893

1904-
.. autodoc2-docstring:: aiida.engine.processes.workchains.workchain.WorkChain.load_instance_state
1905-
19061894
.. py:method:: on_run()
19071895
:canonical: aiida.engine.processes.workchains.workchain.WorkChain.on_run
19081896

‎docs/apidocs/aiida/aiida.manage.rst‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,6 @@ API
357357
.. py:method:: __str__() -> str
358358
:canonical: aiida.manage.configuration.config.ConfigValidationError.__str__
359359

360-
.. autodoc2-docstring:: aiida.manage.configuration.config.ConfigValidationError.__str__
361-
362360
.. py:data:: MIGRATIONS
363361
:canonical: aiida.manage.configuration.migrations.migrations.MIGRATIONS
364362
:value: ()
@@ -394,8 +392,6 @@ API
394392
.. py:method:: __str__() -> str
395393
:canonical: aiida.manage.configuration.options.Option.__str__
396394

397-
.. autodoc2-docstring:: aiida.manage.configuration.options.Option.__str__
398-
399395
.. py:property:: name
400396
:canonical: aiida.manage.configuration.options.Option.name
401397
:type: str
@@ -616,8 +612,6 @@ API
616612
.. py:method:: __repr__() -> str
617613
:canonical: aiida.manage.configuration.profile.Profile.__repr__
618614

619-
.. autodoc2-docstring:: aiida.manage.configuration.profile.Profile.__repr__
620-
621615
.. py:method:: copy()
622616
:canonical: aiida.manage.configuration.profile.Profile.copy
623617

‎docs/apidocs/aiida/aiida.orm.rst‎

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -483,8 +483,6 @@ API
483483
.. py:method:: initialize()
484484
:canonical: aiida.orm.nodes.data.array.array.ArrayData.initialize
485485

486-
.. autodoc2-docstring:: aiida.orm.nodes.data.array.array.ArrayData.initialize
487-
488486
.. py:method:: delete_array(name)
489487
:canonical: aiida.orm.nodes.data.array.array.ArrayData.delete_array
490488

@@ -577,8 +575,6 @@ API
577575
.. py:method:: __setattr__(name, value)
578576
:canonical: aiida.orm.utils.managers.AttributeManager.__setattr__
579577

580-
.. autodoc2-docstring:: aiida.orm.utils.managers.AttributeManager.__setattr__
581-
582578
.. py:method:: __getitem__(name)
583579
:canonical: aiida.orm.utils.managers.AttributeManager.__getitem__
584580

@@ -1458,8 +1454,6 @@ API
14581454
.. py:method:: __str__()
14591455
:canonical: aiida.orm.nodes.data.code.legacy.Code.__str__
14601456

1461-
.. autodoc2-docstring:: aiida.orm.nodes.data.code.legacy.Code.__str__
1462-
14631457
.. py:method:: get_computer_label()
14641458
:canonical: aiida.orm.nodes.data.code.legacy.Code.get_computer_label
14651459

@@ -1507,8 +1501,6 @@ API
15071501
.. py:method:: _validate()
15081502
:canonical: aiida.orm.nodes.data.code.legacy.Code._validate
15091503

1510-
.. autodoc2-docstring:: aiida.orm.nodes.data.code.legacy.Code._validate
1511-
15121504
.. py:method:: validate_remote_exec_path()
15131505
:canonical: aiida.orm.nodes.data.code.legacy.Code.validate_remote_exec_path
15141506

@@ -2986,13 +2978,9 @@ API
29862978
.. py:method:: __repr__()
29872979
:canonical: aiida.orm.nodes.data.structure.Kind.__repr__
29882980

2989-
.. autodoc2-docstring:: aiida.orm.nodes.data.structure.Kind.__repr__
2990-
29912981
.. py:method:: __str__()
29922982
:canonical: aiida.orm.nodes.data.structure.Kind.__str__
29932983

2994-
.. autodoc2-docstring:: aiida.orm.nodes.data.structure.Kind.__str__
2995-
29962984
.. py:class:: KpointsData
29972985
:canonical: aiida.orm.nodes.data.array.kpoints.KpointsData
29982986

@@ -3248,33 +3236,21 @@ API
32483236
.. py:method:: __str__()
32493237
:canonical: aiida.orm.nodes.data.list.List.__str__
32503238

3251-
.. autodoc2-docstring:: aiida.orm.nodes.data.list.List.__str__
3252-
32533239
.. py:method:: __eq__(other)
32543240
:canonical: aiida.orm.nodes.data.list.List.__eq__
32553241

3256-
.. autodoc2-docstring:: aiida.orm.nodes.data.list.List.__eq__
3257-
32583242
.. py:method:: append(value)
32593243
:canonical: aiida.orm.nodes.data.list.List.append
32603244

3261-
.. autodoc2-docstring:: aiida.orm.nodes.data.list.List.append
3262-
32633245
.. py:method:: extend(value)
32643246
:canonical: aiida.orm.nodes.data.list.List.extend
32653247

3266-
.. autodoc2-docstring:: aiida.orm.nodes.data.list.List.extend
3267-
32683248
.. py:method:: insert(i, value)
32693249
:canonical: aiida.orm.nodes.data.list.List.insert
32703250

3271-
.. autodoc2-docstring:: aiida.orm.nodes.data.list.List.insert
3272-
32733251
.. py:method:: remove(value)
32743252
:canonical: aiida.orm.nodes.data.list.List.remove
32753253

3276-
.. autodoc2-docstring:: aiida.orm.nodes.data.list.List.remove
3277-
32783254
.. py:method:: pop(**kwargs)
32793255
:canonical: aiida.orm.nodes.data.list.List.pop
32803256

@@ -3298,8 +3274,6 @@ API
32983274
.. py:method:: reverse()
32993275
:canonical: aiida.orm.nodes.data.list.List.reverse
33003276

3301-
.. autodoc2-docstring:: aiida.orm.nodes.data.list.List.reverse
3302-
33033277
.. py:method:: get_list()
33043278
:canonical: aiida.orm.nodes.data.list.List.get_list
33053279

@@ -3479,13 +3453,9 @@ API
34793453
.. py:method:: __repr__() -> str
34803454
:canonical: aiida.orm.nodes.node.Node.__repr__
34813455

3482-
.. autodoc2-docstring:: aiida.orm.nodes.node.Node.__repr__
3483-
34843456
.. py:method:: __str__() -> str
34853457
:canonical: aiida.orm.nodes.node.Node.__str__
34863458

3487-
.. autodoc2-docstring:: aiida.orm.nodes.node.Node.__str__
3488-
34893459
.. py:method:: __copy__()
34903460
:canonical: aiida.orm.nodes.node.Node.__copy__
34913461

@@ -3814,8 +3784,6 @@ API
38143784
.. py:method:: __repr__()
38153785
:canonical: aiida.orm.utils.managers.NodeLinksManager.__repr__
38163786

3817-
.. autodoc2-docstring:: aiida.orm.utils.managers.NodeLinksManager.__repr__
3818-
38193787
.. py:class:: NodeRepository(node: aiida.orm.nodes.node.Node)
38203788
:canonical: aiida.orm.nodes.repository.NodeRepository
38213789

@@ -4283,8 +4251,6 @@ API
42834251
.. py:method:: __str__() -> str
42844252
:canonical: aiida.orm.nodes.process.process.ProcessNode.__str__
42854253

4286-
.. autodoc2-docstring:: aiida.orm.nodes.process.process.ProcessNode.__str__
4287-
42884254
.. py:method:: _updatable_attributes() -> typing.Tuple[str, ...]
42894255
:canonical: aiida.orm.nodes.process.process.ProcessNode._updatable_attributes
42904256

@@ -4782,8 +4748,6 @@ API
47824748
.. py:method:: _validate()
47834749
:canonical: aiida.orm.nodes.data.remote.base.RemoteData._validate
47844750

4785-
.. autodoc2-docstring:: aiida.orm.nodes.data.remote.base.RemoteData._validate
4786-
47874751
.. py:method:: get_authinfo()
47884752
:canonical: aiida.orm.nodes.data.remote.base.RemoteData.get_authinfo
47894753

@@ -4915,13 +4879,9 @@ API
49154879
.. py:method:: __repr__()
49164880
:canonical: aiida.orm.nodes.data.structure.Site.__repr__
49174881

4918-
.. autodoc2-docstring:: aiida.orm.nodes.data.structure.Site.__repr__
4919-
49204882
.. py:method:: __str__()
49214883
:canonical: aiida.orm.nodes.data.structure.Site.__str__
49224884

4923-
.. autodoc2-docstring:: aiida.orm.nodes.data.structure.Site.__str__
4924-
49254885
.. py:class:: Str
49264886
:canonical: aiida.orm.nodes.data.str.Str
49274887

‎docs/apidocs/aiida/aiida.repository.rst‎

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,6 @@ API
185185
:canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.key_format
186186
:type: typing.Optional[str]
187187

188-
.. autodoc2-docstring:: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.key_format
189-
190188
.. py:method:: initialise(**kwargs) -> None
191189
:canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.initialise
192190

@@ -211,8 +209,6 @@ API
211209
.. py:method:: has_objects(keys: typing.List[str]) -> typing.List[bool]
212210
:canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.has_objects
213211

214-
.. autodoc2-docstring:: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.has_objects
215-
216212
.. py:method:: open(key: str) -> typing.Iterator[typing.BinaryIO]
217213
:canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.open
218214

@@ -221,18 +217,12 @@ API
221217
.. py:method:: iter_object_streams(keys: typing.List[str]) -> typing.Iterator[typing.Tuple[str, typing.BinaryIO]]
222218
:canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.iter_object_streams
223219

224-
.. autodoc2-docstring:: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.iter_object_streams
225-
226220
.. py:method:: delete_objects(keys: typing.List[str]) -> None
227221
:canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.delete_objects
228222

229-
.. autodoc2-docstring:: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.delete_objects
230-
231223
.. py:method:: list_objects() -> typing.Iterable[str]
232224
:canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.list_objects
233225

234-
.. autodoc2-docstring:: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.list_objects
235-
236226
.. py:method:: get_object_hash(key: str) -> str
237227
:canonical: aiida.repository.backend.disk_object_store.DiskObjectStoreRepositoryBackend.get_object_hash
238228

@@ -310,8 +300,6 @@ API
310300
.. py:method:: __repr__()
311301
:canonical: aiida.repository.common.File.__repr__
312302

313-
.. autodoc2-docstring:: aiida.repository.common.File.__repr__
314-
315303
.. py:class:: FileType
316304
:canonical: aiida.repository.common.FileType
317305

@@ -548,8 +536,6 @@ API
548536
:canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.key_format
549537
:type: str | None
550538

551-
.. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.key_format
552-
553539
.. py:method:: initialise(**kwargs) -> None
554540
:canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.initialise
555541

@@ -579,36 +565,22 @@ API
579565
.. py:method:: has_objects(keys: list[str]) -> list[bool]
580566
:canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.has_objects
581567

582-
.. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.has_objects
583-
584568
.. py:method:: open(key: str) -> typing.Iterator[typing.BinaryIO]
585569
:canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.open
586570

587-
.. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.open
588-
589571
.. py:method:: iter_object_streams(keys: list[str]) -> typing.Iterator[tuple[str, typing.BinaryIO]]
590572
:canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.iter_object_streams
591573

592-
.. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.iter_object_streams
593-
594574
.. py:method:: delete_objects(keys: list[str]) -> None
595575
:canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.delete_objects
596576

597-
.. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.delete_objects
598-
599577
.. py:method:: list_objects() -> typing.Iterable[str]
600578
:canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.list_objects
601579

602-
.. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.list_objects
603-
604580
.. py:method:: maintain(dry_run: bool = False, live: bool = True, **kwargs) -> None
605581
:canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.maintain
606582
:abstractmethod:
607583

608-
.. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.maintain
609-
610584
.. py:method:: get_info(detailed: bool = False, **kwargs) -> dict
611585
:canonical: aiida.repository.backend.sandbox.SandboxRepositoryBackend.get_info
612586
:abstractmethod:
613-
614-
.. autodoc2-docstring:: aiida.repository.backend.sandbox.SandboxRepositoryBackend.get_info

‎docs/apidocs/aiida/aiida.schedulers.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -363,8 +363,6 @@ API
363363
.. py:method:: __str__()
364364
:canonical: aiida.schedulers.scheduler.Scheduler.__str__
365365

366-
.. autodoc2-docstring:: aiida.schedulers.scheduler.Scheduler.__str__
367-
368366
.. py:method:: preprocess_resources(resources, default_mpiprocs_per_machine=None)
369367
:canonical: aiida.schedulers.scheduler.Scheduler.preprocess_resources
370368
:classmethod:

‎docs/apidocs/aiida/aiida.tools.rst‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -392,13 +392,9 @@ API
392392
.. py:method:: __repr__()
393393
:canonical: aiida.tools.data.orbital.orbital.Orbital.__repr__
394394

395-
.. autodoc2-docstring:: aiida.tools.data.orbital.orbital.Orbital.__repr__
396-
397395
.. py:method:: __str__() -> str
398396
:canonical: aiida.tools.data.orbital.orbital.Orbital.__str__
399397

400-
.. autodoc2-docstring:: aiida.tools.data.orbital.orbital.Orbital.__str__
401-
402398
.. py:method:: _validate_keys(input_dict)
403399
:canonical: aiida.tools.data.orbital.orbital.Orbital._validate_keys
404400

‎docs/apidocs/aiida/aiida.transports.rst‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -300,13 +300,9 @@ API
300300
.. py:method:: copyfile(remotesource, remotedestination, dereference=False)
301301
:canonical: aiida.transports.plugins.ssh.SshTransport.copyfile
302302

303-
.. autodoc2-docstring:: aiida.transports.plugins.ssh.SshTransport.copyfile
304-
305303
.. py:method:: copytree(remotesource, remotedestination, dereference=False)
306304
:canonical: aiida.transports.plugins.ssh.SshTransport.copytree
307305

308-
.. autodoc2-docstring:: aiida.transports.plugins.ssh.SshTransport.copytree
309-
310306
.. py:method:: copy(remotesource, remotedestination, dereference=False, recursive=True)
311307
:canonical: aiida.transports.plugins.ssh.SshTransport.copy
312308

@@ -451,13 +447,9 @@ API
451447
.. py:method:: __repr__()
452448
:canonical: aiida.transports.transport.Transport.__repr__
453449

454-
.. autodoc2-docstring:: aiida.transports.transport.Transport.__repr__
455-
456450
.. py:method:: __str__()
457451
:canonical: aiida.transports.transport.Transport.__str__
458452

459-
.. autodoc2-docstring:: aiida.transports.transport.Transport.__str__
460-
461453
.. py:method:: set_logger_extra(logger_extra)
462454
:canonical: aiida.transports.transport.Transport.set_logger_extra
463455

0 commit comments

Comments
 (0)