diff --git a/aiida/sphinxext/calcjob.py b/aiida/sphinxext/calcjob.py index a43868a8ea..539377be72 100644 --- a/aiida/sphinxext/calcjob.py +++ b/aiida/sphinxext/calcjob.py @@ -18,7 +18,7 @@ def setup_extension(app): app.add_directive_to_domain('py', AiidaCalcJobDocumenter.directivetype, AiidaCalcJobDirective) - app.add_autodocumenter(AiidaCalcJobDocumenter) + # app.add_autodocumenter(AiidaCalcJobDocumenter) class AiidaCalcJobDocumenter(AiidaProcessDocumenter): diff --git a/aiida/sphinxext/process.py b/aiida/sphinxext/process.py index 736756a12b..4c80cefbeb 100644 --- a/aiida/sphinxext/process.py +++ b/aiida/sphinxext/process.py @@ -31,7 +31,7 @@ def setup_extension(app): app.add_directive_to_domain('py', AiidaProcessDocumenter.directivetype, AiidaProcessDirective) - app.add_autodocumenter(AiidaProcessDocumenter) + # app.add_autodocumenter(AiidaProcessDocumenter) class AiidaProcessDocumenter(ClassDocumenter): diff --git a/aiida/sphinxext/workchain.py b/aiida/sphinxext/workchain.py index 97614aa051..d3dcf7f47a 100644 --- a/aiida/sphinxext/workchain.py +++ b/aiida/sphinxext/workchain.py @@ -18,7 +18,7 @@ def setup_extension(app): app.add_directive_to_domain('py', AiidaWorkChainDocumenter.directivetype, AiidaWorkchainDirective) - app.add_autodocumenter(AiidaWorkChainDocumenter) + # app.add_autodocumenter(AiidaWorkChainDocumenter) class AiidaWorkChainDocumenter(AiidaProcessDocumenter): diff --git a/docs/source/nitpick-exceptions b/docs/source/nitpick-exceptions index 59b92158be..8dd897435c 100644 --- a/docs/source/nitpick-exceptions +++ b/docs/source/nitpick-exceptions @@ -42,7 +42,7 @@ py:meth click.Option.get_default py:class concurrent.futures._base.TimeoutError -py:class docutils.parsers.rst.Directive +py:class sphinx.util.docutils.SphinxDirective py:class frozenset diff --git a/tests/sphinxext/reference_results/workchain.xml b/tests/sphinxext/reference_results/workchain.xml index 620c15b52d..e7fae40799 100644 --- a/tests/sphinxext/reference_results/workchain.xml +++ b/tests/sphinxext/reference_results/workchain.xml @@ -1,7 +1,7 @@ - +
sphinx-aiida demo This is a demo documentation to show off the features of the sphinx-aiida extension. @@ -72,30 +72,18 @@ finalize This module defines an example workchain for the aiida-workchain documentation directive. - - workchaindemo_workchain.DemoWorkChain + + + class demo_workchain.DemoWorkChain*args**kwargs - - A demo workchain to show how the workchain auto-documentation works. - - Inputs:metadata, Namespace
Namespace Portscall_link_label, str, optional, non_db – The label to use for the CALL link if the process is called by another process.description, str, optional, non_db – Description to set on the process node.label, str, optional, non_db – Label to set on the process node.store_provenance, bool, optional, non_db – If set to False provenance will not be stored in the database.
nsp, Namespace – A separate namespace, nsp.nsp2, Namespacex, Float, required – First input argument.y, Namespace
Namespace Portsnested, Namespace – A nested namespace.
Namespace Portsa, Int, required – An input in the nested namespace.
z, Int, required – Input in a separate namespace.
- Outputs:z, Bool, required – Output of the demoworkchain. - Outline:start -while(some_check) - do_something - if(another_check) - do_something_else -finalize + A demo workchain to show how the workchain auto-documentation works.
- - workchaindemo_workchain.EmptyOutlineWorkChain + + + class demo_workchain.EmptyOutlineWorkChain*args**kwargs - - Here we check that the directive works even if the outline is empty. - - Inputs:metadata, Namespace
Namespace Portscall_link_label, str, optional, non_db – The label to use for the CALL link if the process is called by another process.description, str, optional, non_db – Description to set on the process node.label, str, optional, non_db – Label to set on the process node.store_provenance, bool, optional, non_db – If set to False provenance will not be stored in the database.
x, Float, required – First input argument.
- Outputs:None defined. + Here we check that the directive works even if the outline is empty.