Basf2VariableObject Class Reference

Inheritance diagram for Basf2VariableObject:

Public Member Functions
	handle_signature (self, sig, signode)

Public Attributes
	options

Static Public Attributes
	option_spec = Basf2Object.option_spec.copy() if hasattr(Basf2Object, "option_spec") else {}

Detailed Description

Definition at line 123 of file basf2domain.py.

Member Function Documentation

handle_signature()

handle_signature	(		self,
			sig,
			signode )

Definition at line 130 of file basf2domain.py.

    def handle_signature(self, sig, signode):
        # Call parent to parse the signature and add the variable name
        name = super().handle_signature(sig, signode)
 
        # If :source: option is given, add a [source] link inline
        if "source" in self.options:
            uri = self.options["source"]
            linknode = nodes.reference('', '[source]', refuri=uri, classes=['var-source-link'])
            signode += linknode
 
        return name
 
 

Member Data Documentation

option_spec

option_spec = Basf2Object.option_spec.copy() if hasattr(Basf2Object, "option_spec") else {}

static

Definition at line 125 of file basf2domain.py.

options

options

Definition at line 135 of file basf2domain.py.

---

The documentation for this class was generated from the following file:

• site_scons/sphinx/extensions/basf2domain.py