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)[源代码]#
-
- __module__ = 'aiida.sphinxext.calcjob'#
- annotation = 'calcjob'#
- signature = 'CalcJob'#
- class aiida.sphinxext.calcjob.AiidaCalcJobDocumenter(*args: Any)[源代码]#
-
Sphinx Documenter for AiiDA CalcJobs.
- __annotations__ = {}#
- __module__ = 'aiida.sphinxext.calcjob'#
- classmethod can_document_member(member, membername, isattr, parent)[源代码]#
Called to see if a member can be documented by this Documenter.
- directivetype = 'aiida-calcjob'#
- objtype = 'calcjob'#
name by which the directive is called (auto…) and the default generated directive name
- priority = 20#
priority if multiple documenters return True from can_document_member
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)[源代码]#
基类:
SphinxDirective
Directive to auto-document AiiDA processes.
- EXPAND_NAMESPACES_FLAG = 'expand-namespaces'#
- HIDE_UNSTORED_INPUTS_FLAG = 'hide-nondb-inputs'#
- __annotations__ = {}#
- __module__ = 'aiida.sphinxext.process'#
- annotation = 'process'#
- build_doctree(title, port_namespace)[源代码]#
Returns a doctree for a given port namespace, including a title.
- build_outline_lines(outline, indent)[源代码]#
Return a list of lines which describe the process outline.
- final_argument_whitespace = True#
May the final argument contain whitespace?
- has_content = True#
May the directive have content?
- option_spec = {'expand-namespaces': <function flag>, 'hide-nondb-inputs': <function flag>, 'module': <function unchanged_required>}#
Mapping of option names to validator functions.
- optional_arguments = 0#
Number of optional arguments after the required arguments.
- required_arguments = 1#
Number of required directive arguments.
- signature = 'Process'#
- class aiida.sphinxext.process.AiidaProcessDocumenter(*args: Any)[源代码]#
基类:
ClassDocumenter
Sphinx Documenter class for AiiDA Processes.
- __annotations__ = {}#
- __module__ = 'aiida.sphinxext.process'#
- classmethod can_document_member(member, membername, isattr, parent)[源代码]#
Called to see if a member can be documented by this Documenter.
- directivetype = 'aiida-process'#
- objtype = 'process'#
name by which the directive is called (auto…) and the default generated directive name
- priority = 10#
priority if multiple documenters return True from can_document_member
Defines an rst directive to auto-document AiiDA workchains.
- class aiida.sphinxext.workchain.AiidaWorkChainDocumenter(*args: Any)[源代码]#
-
Sphinx Documenter class for AiiDA WorkChains.
- __annotations__ = {}#
- __module__ = 'aiida.sphinxext.workchain'#
- classmethod can_document_member(member, membername, isattr, parent)[源代码]#
Called to see if a member can be documented by this Documenter.
- directivetype = 'aiida-workchain'#
- objtype = 'workchain'#
name by which the directive is called (auto…) and the default generated directive name
- priority = 20#
priority if multiple documenters return True from can_document_member