aiida.sphinxext package

Defines reStructuredText directives to simplify documenting AiiDA and its plugins.

aiida.sphinxext.setup(app)[source]

Setup function to add the extension classes / nodes to Sphinx.

Submodules

Defines an rst directive to auto-document AiiDA workchains.

class aiida.sphinxext.workchain.AiidaWorkchainDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

Bases: docutils.parsers.rst.Directive

Directive to auto-document AiiDA workchains.

HIDE_UNSTORED_INPUTS_FLAG = 'hide-nondb-inputs'
__module__ = 'aiida.sphinxext.workchain'
build_content()[source]

Returns the main content (docstring, inputs, outputs) of the workchain documentation.

build_doctree(title, port_namespace)[source]

Returns a doctree for a given port namespace, including a title.

build_node_tree()[source]

Returns the docutils node tree.

build_port_paragraph(name, port)[source]

Build the paragraph that describes a single port.

build_portnamespace_doctree(port_namespace)[source]

Builds the doctree for a port namespace.

build_signature()[source]

Returns the signature of the workchain.

final_argument_whitespace = True
static format_valid_types(valid_type)[source]

Format valid input/output types.

Parameters:valid_type – class
Returns:formatted string
has_content = True
load_workchain()[source]

Loads the workchain and sets up additional attributes.

option_spec = {'hide-nondb-inputs': <function flag>, 'module': <function unchanged>}
optional_arguments = 0
required_arguments = 1
run()[source]
class aiida.sphinxext.workchain.WorkChainDocumenter(*args)[source]

Bases: sphinx.ext.autodoc.ClassDocumenter

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
aiida.sphinxext.workchain._is_non_db(port)[source]
aiida.sphinxext.workchain.setup_aiida_workchain(app)[source]

Add sphinx directive.