Defines reStructuredText directives to simplify documenting AiiDA and its plugins.
aiida.sphinxext.
setup
Setup function to add the extension classes / nodes to Sphinx.
Defines an rst directive to auto-document AiiDA calculation job.
aiida.sphinxext.calcjob.
AiidaCalcJobDirective
Bases: aiida.sphinxext.process.AiidaProcessDirective
aiida.sphinxext.process.AiidaProcessDirective
__module__
annotation
signature
AiidaCalcJobDocumenter
Bases: aiida.sphinxext.process.AiidaProcessDocumenter
aiida.sphinxext.process.AiidaProcessDocumenter
Sphinx Documenter for AiiDA CalcJobs.
can_document_member
Called to see if a member can be documented by this documenter.
directivetype
objtype
priority
setup_extension
Defines an rst directive to auto-document AiiDA processes.
aiida.sphinxext.process.
AiidaProcessDirective
Bases: sphinx.util.docutils.SphinxDirective
sphinx.util.docutils.SphinxDirective
Directive to auto-document AiiDA processes.
EXPAND_NAMESPACES_FLAG
HIDE_UNSTORED_INPUTS_FLAG
build_content
Returns the main content (docstring, inputs, outputs) of the documentation.
build_doctree
Returns a doctree for a given port namespace, including a title.
build_node_tree
Returns the docutils node tree.
build_outline_doctree
Build the doctree for a spec outline.
build_outline_lines
Return a list of lines which describe the process outline.
build_port_content
Build the content that describes a single port.
build_portnamespace_doctree
Builds the doctree for a port namespace.
build_signature
Returns the signature of the process.
final_argument_whitespace
format_valid_types
Format valid types.
has_content
initialize
Set internal attributes of the class.
Includes importing the process class.
option_spec
optional_arguments
required_arguments
run
AiidaProcessDocumenter
Bases: sphinx.ext.autodoc.ClassDocumenter
sphinx.ext.autodoc.ClassDocumenter
Sphinx Documenter class for AiiDA Processes.
_is_non_db
Defines an rst directive to auto-document AiiDA workchains.
aiida.sphinxext.workchain.
AiidaWorkChainDocumenter
Sphinx Documenter class for AiiDA WorkChains.
AiidaWorkchainDirective