Configuration

The extension provides the following configuration:

obj_domain_name

Type:

str

Default:

'obj'

Name of the domain

obj_type_defines

Type:

dict

Default:

{}

A dictionary dict[str, objdef] of object type definitions. The str key is the object type; The objdef vaule is also a dict, please refer to Object Type Definiton for more details.

obj_domain_dump

Type:

bool

Default:

True

Whether dump domain data to $DOCTREE_DIR/$OBJ_DOMAIN_NAME-objects.json.

The $DOCTREE_DIR is usually _build/doctrees/. The $OBJ_DOMAIN_NAME refers value of obj_domain_name. (By default, the path is _build/doctrees/obj-objects.json)