Basf2Domain Class Reference

Inheritance diagram for Basf2Domain:

Collaboration diagram for Basf2Domain:

Public Member Functions
def	clear_doc (self, docname)
def	get_objects (self)
def	get_type_name (self, type, primary=False)
def	resolve_xref (self, env, fromdocname, builder, typ, target, node, contnode)

Static Public Attributes
string	name = "b2"
string	label = "Belle II Software"
dictionary	object_types
dictionary	directives
dictionary	roles
dictionary	initial_data
list	indices

Detailed Description

basf2 Software Domain

Definition at line 113 of file basf2domain.py.

Member Function Documentation

clear_doc()

def clear_doc	(		self,
			docname
	)

Remove the existing domain data for a given document name

Definition at line 139 of file basf2domain.py.

    def clear_doc(self, docname):
        """Remove the existing domain data for a given document name"""
        for t in "modules", "variables":
            try:
                for name, (doc, target) in list(self.data[t].items()):
                    if doc == docname:
                        del self.data[t][name]
            except Exception:
                pass
 

Member Data Documentation

directives

dictionary directives

static

Initial value:

=  {
        "module": Basf2Object,
        "variable": Basf2Object,
    }

Definition at line 122 of file basf2domain.py.

indices

list indices

static

Initial value:

=  [
        Basf2ModuleIndex,
        Basf2VariableIndex,
    ]

Definition at line 134 of file basf2domain.py.

initial_data

dictionary initial_data

static

Initial value:

=  {
        "modules": {},
        "variables": {},
    }

Definition at line 130 of file basf2domain.py.

object_types

dictionary object_types

static

Initial value:

=  {
        "module": ObjType("module", "mod"),
        "variable": ObjType("variable", "var")
    }

Definition at line 117 of file basf2domain.py.

roles

dictionary roles

static

Initial value:

=  {
        "mod": XRefRole(),
        "var": XRefRole(),
    }

Definition at line 126 of file basf2domain.py.

---

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

• site_scons/sphinx/extensions/basf2domain.py