Autoref plugin
IDEA: Tweak the AutoRefsPlugin so that text in backticks like this
(more IDE-friendly) are
considered refs when possible.
default_reference_sources
module-attribute
#
default_reference_sources = [
Trainer,
LightningModule,
LightningDataModule,
Module,
]
These are some "known objects" that can be referenced with backticks anywhere in the docs.
Additionally, if there were modules in here, then any of their public members can also be referenced.
CustomAutoRefPlugin #
Bases: BasePlugin
Small mkdocs plugin that converts backticks to refs when possible.