sphinxnotes.any - Sphinx Domain for Descibing Anything¶

submited by

Style Pass

2021-06-05 04:00:07

The extension provides a domain which allows user creates directive and roles to descibe, reference and index arbitrary object in documentation by writing reStructuredText templates. It is a bit like sphinx.application.Sphinx.add_object_type(), but more powerful.

Before descibing any object, we need a “schema” to tell extension “how to descibe the object”. For extension user, “schema” is a python object that can specific in configuration value ⚙️any_schemas.

objtype (str) – The unique type name of object, it will be used as basename of corresponding Directives , Roles and Indices

Whether the field is unique. If true, the value of field must be unique within the scope of objects with same type. And it will be used as base string of object identifier.

referenceable (bool) – Whether the field is referenceable. If ture, object can be referenced by field value. See Roles for more details.