aiida.sphinxext package¶
Defines reStructuredText directives to simplify documenting AiiDA and its plugins.
Submodules¶
Defines an rst directive to auto-document AiiDA calculation job.
-
class
aiida.sphinxext.calcjob.
AiidaCalcJobDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Bases:
aiida.sphinxext.process.AiidaProcessDirective
-
__module__
= 'aiida.sphinxext.calcjob'¶
-
annotation
= 'calcjob'¶
-
signature
= 'CalcJob'¶
-
-
class
aiida.sphinxext.calcjob.
AiidaCalcJobDocumenter
(*args)[source]¶ Bases:
aiida.sphinxext.process.AiidaProcessDocumenter
Sphinx Documenter for AiiDA CalcJobs.
-
__module__
= 'aiida.sphinxext.calcjob'¶
-
classmethod
can_document_member
(member, membername, isattr, parent)[source]¶ Called to see if a member can be documented by this documenter.
-
directivetype
= 'aiida-calcjob'¶
-
objtype
= 'calcjob'¶
-
priority
= 20¶
-
Defines an rst directive to auto-document AiiDA processes.
-
class
aiida.sphinxext.process.
AiidaProcessDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Bases:
docutils.parsers.rst.Directive
Directive to auto-document AiiDA processes.
-
HIDE_UNSTORED_INPUTS_FLAG
= 'hide-nondb-inputs'¶
-
__module__
= 'aiida.sphinxext.process'¶
-
annotation
= 'process'¶
-
build_content
()[source]¶ Returns the main content (docstring, inputs, outputs) of the documentation.
-
build_doctree
(title, port_namespace)[source]¶ Returns a doctree for a given port namespace, including a title.
-
final_argument_whitespace
= True¶
-
has_content
= True¶
-
option_spec
= {'hide-nondb-inputs': <function flag>, 'module': <function unchanged>}¶
-
optional_arguments
= 0¶
-
required_arguments
= 1¶
-
signature
= 'Process'¶
-
-
class
aiida.sphinxext.process.
AiidaProcessDocumenter
(*args)[source]¶ Bases:
sphinx.ext.autodoc.ClassDocumenter
Sphinx Documenter class for AiiDA Processes.
-
__module__
= 'aiida.sphinxext.process'¶
-
classmethod
can_document_member
(member, membername, isattr, parent)[source]¶ Called to see if a member can be documented by this documenter.
-
directivetype
= 'aiida-process'¶
-
objtype
= 'process'¶
-
priority
= 10¶
-
Defines an rst directive to auto-document AiiDA workchains.
-
class
aiida.sphinxext.workchain.
AiidaWorkChainDocumenter
(*args)[source]¶ Bases:
aiida.sphinxext.process.AiidaProcessDocumenter
Sphinx Documenter class for AiiDA WorkChains.
-
__module__
= 'aiida.sphinxext.workchain'¶
-
classmethod
can_document_member
(member, membername, isattr, parent)[source]¶ Called to see if a member can be documented by this documenter.
-
directivetype
= 'aiida-workchain'¶
-
objtype
= 'workchain'¶
-
priority
= 20¶
-
-
class
aiida.sphinxext.workchain.
AiidaWorkchainDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Bases:
aiida.sphinxext.process.AiidaProcessDirective
-
__module__
= 'aiida.sphinxext.workchain'¶
-
annotation
= 'workchain'¶
-
signature
= 'WorkChain'¶
-