Skip to content

Document suppressing cross-references via ! prefix #12940

@timhoffm

Description

@timhoffm

I just learned from the sphinx doc sources that one can disable cross-references by prefixing the reference with an exclamation mark.

The relevant source code seems to be:

# if the first character is a bang, don't cross-reference at all
self.disabled = text.startswith('!')

I haven't found anything about this in the documentation. Is this an official feature? If so, we should document it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions