Pre-defined `sphinxnotes-any` Objects¶

The `version` Object¶

System Message: ERROR/2 (/home/runner/work/project/project/docs/sphinxnotes_any.rst, line 10)

Render Report:

Unresolved context:¶

UnparsedData(raw=RawData(name='any:version', attrs={}, content=''),
             schema=Schema(name=Field(etype=<class 'str'>,
                                      ctype=<class 'list'>,
                                      flags={'index': [],
                                             'ref': False,
                                             'required': False,
                                             'sep': ':',
                                             'uniq': False},
                                      dsl='list of str, sep by ":"'),
                           attrs={},
                           content=Field(etype=<class 'str'>,
                                         ctype=None,
                                         flags={'index': [],
                                                'ref': False,
                                                'required': False,
                                                'sep': None,
                                                'uniq': False},
                                         dsl='str')))

Resolved context (type: <class ‘sphinxnotes.render.data.ParsedData’>):¶

ParsedData(name=['any', 'version'], attrs={}, content=None)

Template (phase: Phase.Parsing):¶

{% set domain = load_extra('app').registry.domains[name[0]] %}
{% set dir = domain.directives[name[1]] %}
{% set roles = domain.roles %}
{% set schema = domain.schemas[name[1]] %}
{% set dispname = name[1] %}

Directive for documenting ``{{ dispname }}`` object:

.. role:: py(code)
   :language: Python

.. rst:directive:: .. {{ dispname }}:: {% if schema.name %}name ({{ schema.name.dsl }}){% endif %}

   {% for attr, field in schema.attrs.items() %}
   .. rst:directive:option:: {{ attr }}
      :type: {{ field.dsl }}
   {% endfor %}

   {% if schema.content %}``content ({{ schema.content.dsl }})``{% endif %}

Cross-reference roles for referencing a ``{{ dispname }}`` object:

{% if schema.name.ref %}
.. rst:role:: {{ dispname }}
   
   Referencing a {{ dispname }} object by name.
{% endif %}

{% for attr, field in schema.attrs.items() %}
{% if field.ref %}
.. rst:role:: {{ dispname }}.{{ attr }}
   
   Referencing a {{ dispname }} object by attribute "{{ attr }}".
{% endif %}
{% endfor %}

{% for line in (content or '').split('\n') -%}
{{ line }}
{% endfor %}

Available extra context names:¶

['app', 'doc', 'env', 'markup', 'section']

Failed to render Jinja template:¶

'BuildEnvironment' object is not iterable

The `example` Object¶

System Message: ERROR/2 (/home/runner/work/project/project/docs/sphinxnotes_any.rst, line 15)