Directives#

class FortranFunction(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#

Bases: FortranObject

objtype: str = 'function'#

class FortranInterface(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#

Bases: FortranObject

objtype: str = 'interface'#

class FortranModule(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#

Bases: Directive

required_arguments = 1#: Number of required directive arguments.

run()[source]#

class FortranObject(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#

Bases: ObjectDescription[str]

Base directive for Fortran objects (manual declarations).

add_target_and_index(name: str, sig: str, signode: desc_signature) → None[source]#

Add cross-reference IDs and entries to self.indexnode, if applicable.

name is whatever handle_signature() returned.

handle_signature(sig: str, signode: desc_signature) → str[source]#

Parse the signature sig.

The individual nodes are then appended to signode. If ValueError is raised, parsing is aborted and the whole sig is put into a single desc_name node.

The return value should be a value that identifies the object. It is passed to add_target_and_index() unchanged, and otherwise only used to skip duplicates.

has_content = True#: May the directive have content?

required_arguments = 1#: Number of required directive arguments.

class FortranProgram(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#

Bases: Directive

option_spec = {'no-procedures': <function flag>, 'no-show-code': <function flag>, 'procedures': <function flag>}#: Mapping of option names to validator functions.

required_arguments = 1#: Number of required directive arguments.

run()[source]#

class FortranProgramDecl(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#