dagstd.sphinx package

Submodules

dagstd.sphinx.parser module

class dagstd.sphinx.parser.OpDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: PyFunction

Sphinx op directive.

get_signature_prefix(sig)

May return a prefix to put before the object name in the signature.

class dagstd.sphinx.parser.OpDocumenter(directive: DocumenterBridge, name: str, indent: str = '')

Bases: FunctionDocumenter

Document op definitions.

classmethod can_document_member(member, membername, isattr, parent)

Called to see if a member can be documented by this Documenter.

check_module()

Check if self.object is really defined in the module given by self.modname.

document_members(all_members=False)

Generate reST for member documentation.

If all_members is True, document all members, else those given by self.options.members.

format_args(**kwargs: Any)

Format the argument signature of self.object.

Should return None if the object does not have a signature.

member_order = 11

order if autodoc_member_order is set to ‘groupwise’

objtype = 'op'

name by which the directive is called (auto…) and the default generated directive name

dagstd.sphinx.parser.setup(app)

Setup Sphinx extension.

Module contents