Skip to content

Include admonitions in inventoryΒ #2703

@goerz

Description

@goerz

With the addition of anchors for admonitions, it would make sense to also include them in the objects.inv inventory.

These would be in the std domain, label role (same as headings; there isn't really much room in the Sphinx domains to have more semantics). The name would be the anchor name (including the hash), and the dispname would be the title ("Note", "Tip", "Warning", etc. if no title is given).

Presumably, this would require keeping track of these anchors in a field doc.internal.admonitions.map or a similar data structure, akin to doc.internal.headers.map used in the inventory writing.

Not a critical feature, but something nice to have, if I (or someone else) gets around to it.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions