Skip to content

Commit 3391b4b

Browse files
chrisjsewellchrisjsewell
committed
✨ autodoc2-object directive
1 parent d208f5a commit 3391b4b

Some content is hidden

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

47 files changed

+817
-702
lines changed

‎.github/workflows/main.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ jobs:
2424
test:
2525

2626
strategy:
27+
fail-fast: false
2728
matrix:
2829
python-version: ["3.8", "3.9", "3.10", "3.11"]
2930
platform: [ubuntu-latest]

‎.pre-commit-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# See https://pre-commit.com for more information
22
# See https://pre-commit.com/hooks.html for more hooks
33

4-
exclude: ^tests/.*\.md|tests/.*\.rst|docs/apidocs/.*
4+
exclude: ^tests/.*\.md|tests/.*\.rst|tests/.*\.xml|docs/apidocs/.*
55

66
repos:
77
- repo: https://github.com/pre-commit/pre-commit-hooks

‎docs/apidocs/aiida/aiida.cmdline.rst‎

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,6 @@ API
185185
:canonical: aiida.cmdline.params.types.calculation.CalculationParamType.orm_class_loader
186186

187187
.. autodoc2-docstring:: aiida.cmdline.params.types.calculation.CalculationParamType.orm_class_loader
188-
:parser:
189188

190189
.. py:class:: CodeParamType(sub_classes=None, entry_point=None)
191190
:canonical: aiida.cmdline.params.types.code.CodeParamType
@@ -208,7 +207,6 @@ API
208207
:canonical: aiida.cmdline.params.types.code.CodeParamType.orm_class_loader
209208

210209
.. autodoc2-docstring:: aiida.cmdline.params.types.code.CodeParamType.orm_class_loader
211-
:parser:
212210

213211
.. py:method:: shell_complete(ctx, param, incomplete)
214212
:canonical: aiida.cmdline.params.types.code.CodeParamType.shell_complete
@@ -237,7 +235,6 @@ API
237235
:canonical: aiida.cmdline.params.types.computer.ComputerParamType.orm_class_loader
238236

239237
.. autodoc2-docstring:: aiida.cmdline.params.types.computer.ComputerParamType.orm_class_loader
240-
:parser:
241238

242239
.. py:method:: shell_complete(ctx, param, incomplete)
243240
:canonical: aiida.cmdline.params.types.computer.ComputerParamType.shell_complete
@@ -288,7 +285,6 @@ API
288285
:canonical: aiida.cmdline.params.types.data.DataParamType.orm_class_loader
289286

290287
.. autodoc2-docstring:: aiida.cmdline.params.types.data.DataParamType.orm_class_loader
291-
:parser:
292288

293289
.. py:class:: DynamicEntryPointCommandGroup(command, entry_point_group: str, entry_point_name_filter='.*', **kwargs)
294290
:canonical: aiida.cmdline.groups.dynamic.DynamicEntryPointCommandGroup
@@ -426,7 +422,6 @@ API
426422
:canonical: aiida.cmdline.params.types.group.GroupParamType.orm_class_loader
427423

428424
.. autodoc2-docstring:: aiida.cmdline.params.types.group.GroupParamType.orm_class_loader
429-
:parser:
430425

431426
.. py:method:: shell_complete(ctx, param, incomplete)
432427
:canonical: aiida.cmdline.params.types.group.GroupParamType.shell_complete
@@ -477,7 +472,6 @@ API
477472
:abstractmethod:
478473

479474
.. autodoc2-docstring:: aiida.cmdline.params.types.identifier.IdentifierParamType.orm_class_loader
480-
:parser:
481475

482476
.. py:method:: convert(value, param, ctx)
483477
:canonical: aiida.cmdline.params.types.identifier.IdentifierParamType.convert
@@ -534,13 +528,11 @@ API
534528
:canonical: aiida.cmdline.params.types.choice.LazyChoice._click_choice
535529

536530
.. autodoc2-docstring:: aiida.cmdline.params.types.choice.LazyChoice._click_choice
537-
:parser:
538531

539532
.. py:property:: choices
540533
:canonical: aiida.cmdline.params.types.choice.LazyChoice.choices
541534

542535
.. autodoc2-docstring:: aiida.cmdline.params.types.choice.LazyChoice.choices
543-
:parser:
544536

545537
.. py:method:: get_metavar(param)
546538
:canonical: aiida.cmdline.params.types.choice.LazyChoice.get_metavar
@@ -623,7 +615,6 @@ API
623615
:canonical: aiida.cmdline.params.types.node.NodeParamType.orm_class_loader
624616

625617
.. autodoc2-docstring:: aiida.cmdline.params.types.node.NodeParamType.orm_class_loader
626-
:parser:
627618

628619
.. py:class:: NonEmptyStringParamType
629620
:canonical: aiida.cmdline.params.types.strings.NonEmptyStringParamType
@@ -707,13 +698,11 @@ API
707698
:canonical: aiida.cmdline.params.types.plugin.PluginParamType.groups
708699

709700
.. autodoc2-docstring:: aiida.cmdline.params.types.plugin.PluginParamType.groups
710-
:parser:
711701

712702
.. py:property:: has_potential_ambiguity
713703
:canonical: aiida.cmdline.params.types.plugin.PluginParamType.has_potential_ambiguity
714704

715705
.. autodoc2-docstring:: aiida.cmdline.params.types.plugin.PluginParamType.has_potential_ambiguity
716-
:parser:
717706

718707
.. py:method:: get_valid_arguments()
719708
:canonical: aiida.cmdline.params.types.plugin.PluginParamType.get_valid_arguments
@@ -767,7 +756,6 @@ API
767756
:canonical: aiida.cmdline.params.types.process.ProcessParamType.orm_class_loader
768757

769758
.. autodoc2-docstring:: aiida.cmdline.params.types.process.ProcessParamType.orm_class_loader
770-
:parser:
771759

772760
.. py:class:: ProfileParamType(*args, **kwargs)
773761
:canonical: aiida.cmdline.params.types.profile.ProfileParamType
@@ -903,76 +891,63 @@ API
903891
:canonical: aiida.cmdline.params.types.workflow.WorkflowParamType.orm_class_loader
904892

905893
.. autodoc2-docstring:: aiida.cmdline.params.types.workflow.WorkflowParamType.orm_class_loader
906-
:parser:
907894

908895
.. py:function:: dbenv()
909896
:canonical: aiida.cmdline.utils.decorators.dbenv
910897

911898
.. autodoc2-docstring:: aiida.cmdline.utils.decorators.dbenv
912-
:parser:
913899

914900
.. py:function:: echo_critical(message: str, bold: bool = False, nl: bool = True, err: bool = True, prefix: bool = True) -> None
915901
:canonical: aiida.cmdline.utils.echo.echo_critical
916902

917903
.. autodoc2-docstring:: aiida.cmdline.utils.echo.echo_critical
918-
:parser:
919904

920905
.. py:function:: echo_dictionary(dictionary, fmt='json+date', sort_keys=True)
921906
:canonical: aiida.cmdline.utils.echo.echo_dictionary
922907

923908
.. autodoc2-docstring:: aiida.cmdline.utils.echo.echo_dictionary
924-
:parser:
925909

926910
.. py:function:: echo_error(message: str, bold: bool = False, nl: bool = True, err: bool = True, prefix: bool = True) -> None
927911
:canonical: aiida.cmdline.utils.echo.echo_error
928912

929913
.. autodoc2-docstring:: aiida.cmdline.utils.echo.echo_error
930-
:parser:
931914

932915
.. py:function:: echo_info(message: str, bold: bool = False, nl: bool = True, err: bool = False, prefix: bool = True) -> None
933916
:canonical: aiida.cmdline.utils.echo.echo_info
934917

935918
.. autodoc2-docstring:: aiida.cmdline.utils.echo.echo_info
936-
:parser:
937919

938920
.. py:function:: echo_report(message: str, bold: bool = False, nl: bool = True, err: bool = False, prefix: bool = True) -> None
939921
:canonical: aiida.cmdline.utils.echo.echo_report
940922

941923
.. autodoc2-docstring:: aiida.cmdline.utils.echo.echo_report
942-
:parser:
943924

944925
.. py:function:: echo_success(message: str, bold: bool = False, nl: bool = True, err: bool = False, prefix: bool = True) -> None
945926
:canonical: aiida.cmdline.utils.echo.echo_success
946927

947928
.. autodoc2-docstring:: aiida.cmdline.utils.echo.echo_success
948-
:parser:
949929

950930
.. py:function:: echo_warning(message: str, bold: bool = False, nl: bool = True, err: bool = False, prefix: bool = True) -> None
951931
:canonical: aiida.cmdline.utils.echo.echo_warning
952932

953933
.. autodoc2-docstring:: aiida.cmdline.utils.echo.echo_warning
954-
:parser:
955934

956935
.. py:function:: format_call_graph(calc_node, max_depth: int = None, info_fn=calc_info)
957936
:canonical: aiida.cmdline.utils.ascii_vis.format_call_graph
958937

959938
.. autodoc2-docstring:: aiida.cmdline.utils.ascii_vis.format_call_graph
960-
:parser:
961939

962940
.. py:function:: is_verbose()
963941
:canonical: aiida.cmdline.utils.common.is_verbose
964942

965943
.. autodoc2-docstring:: aiida.cmdline.utils.common.is_verbose
966-
:parser:
967944

968945
.. py:function:: only_if_daemon_running(echo_function=echo.echo_critical, message=None)
969946
:canonical: aiida.cmdline.utils.decorators.only_if_daemon_running
970947

971948
.. autodoc2-docstring:: aiida.cmdline.utils.decorators.only_if_daemon_running
972-
:parser:
973949

974950
.. py:function:: with_dbenv()
975951
:canonical: aiida.cmdline.utils.decorators.with_dbenv
976952

977953
.. autodoc2-docstring:: aiida.cmdline.utils.decorators.with_dbenv
978-
:parser:

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -801,21 +801,18 @@ API
801801
:type: int
802802

803803
.. autodoc2-docstring:: aiida.common.progress_reporter.ProgressReporterAbstract.total
804-
:parser:
805804

806805
.. py:property:: desc
807806
:canonical: aiida.common.progress_reporter.ProgressReporterAbstract.desc
808807
:type: typing.Optional[str]
809808

810809
.. autodoc2-docstring:: aiida.common.progress_reporter.ProgressReporterAbstract.desc
811-
:parser:
812810

813811
.. py:property:: n
814812
:canonical: aiida.common.progress_reporter.ProgressReporterAbstract.n
815813
:type: int
816814

817815
.. autodoc2-docstring:: aiida.common.progress_reporter.ProgressReporterAbstract.n
818-
:parser:
819816

820817
.. py:method:: __enter__() -> aiida.common.progress_reporter.ProgressReporterAbstract
821818
:canonical: aiida.common.progress_reporter.ProgressReporterAbstract.__enter__
@@ -953,34 +950,28 @@ API
953950
:canonical: aiida.common.progress_reporter.create_callback
954951

955952
.. autodoc2-docstring:: aiida.common.progress_reporter.create_callback
956-
:parser:
957953

958954
.. py:function:: get_progress_reporter() -> typing.Type[aiida.common.progress_reporter.ProgressReporterAbstract]
959955
:canonical: aiida.common.progress_reporter.get_progress_reporter
960956

961957
.. autodoc2-docstring:: aiida.common.progress_reporter.get_progress_reporter
962-
:parser:
963958

964959
.. py:function:: override_log_level(level=logging.CRITICAL)
965960
:canonical: aiida.common.log.override_log_level
966961

967962
.. autodoc2-docstring:: aiida.common.log.override_log_level
968-
:parser:
969963

970964
.. py:function:: set_progress_bar_tqdm(bar_format: typing.Optional[str] = TQDM_BAR_FORMAT, leave: typing.Optional[bool] = False, **kwargs: typing.Any)
971965
:canonical: aiida.common.progress_reporter.set_progress_bar_tqdm
972966

973967
.. autodoc2-docstring:: aiida.common.progress_reporter.set_progress_bar_tqdm
974-
:parser:
975968

976969
.. py:function:: set_progress_reporter(reporter: typing.Optional[typing.Type[aiida.common.progress_reporter.ProgressReporterAbstract]] = None, **kwargs: typing.Any)
977970
:canonical: aiida.common.progress_reporter.set_progress_reporter
978971

979972
.. autodoc2-docstring:: aiida.common.progress_reporter.set_progress_reporter
980-
:parser:
981973

982974
.. py:function:: validate_link_label(link_label)
983975
:canonical: aiida.common.links.validate_link_label
984976

985977
.. autodoc2-docstring:: aiida.common.links.validate_link_label
986-
:parser:

0 commit comments

Comments
 (0)