Pre-defined Objects¶
The version Object¶
Directive for documenting version object:
- .. version:: name (str, required, uniq, ref)¶
- :date: (date, ref, index by year)¶
- :break: (flag)¶
content (str)
Cross-reference roles for referencing a version object:
- :version:¶
Referencing a version object by name.
- :version.date:¶
Referencing a version object by attribute “date”.
The autoconfval Object¶
Directive for documenting autoconfval object:
- .. autoconfval:: name (str)¶
content (str)
Cross-reference roles for referencing a autoconfval object:
The example Object¶
Directive for documenting example object:
Cross-reference roles for referencing a example object:
- :example:¶
Referencing a example object by name.
The autoobj Object¶
Directive for documenting autoobj object:
- .. autoobj:: name (list of str, sep by ":")¶
content (str)
Cross-reference roles for referencing a autoobj object: