Basf2Object Class Reference

Inheritance diagram for Basf2Object:

Collaboration diagram for Basf2Object:

Public Member Functions
def	handle_signature (self, sig, signode)
def	add_target_and_index (self, name, sig, signode)

Static Public Attributes
dictionary	doc_field_types

Detailed Description

A basf2 x-ref directive registered with Sphinx.add_object_type().
Basically copied together from sphinxcontrib-domaintools and sphinxcontrib-adadomain.

Definition at line 19 of file basf2domain.py.

Member Data Documentation

doc_field_types

dictionary doc_field_types

static

Initial value:

=  {
        TypedField("parameter", label="Parameters", names=("param", "parameter", "arg", "argument"),
                   typenames=("paramtype", "type"), typerolename=None, can_collapse=True),
        Field('returnvalue', label='Returns', has_arg=False,
              names=('returns', 'return')),
    }

Definition at line 25 of file basf2domain.py.

---

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

• site_scons/sphinx/extensions/basf2domain.py