decorators
¶
reStructuredText XRef role for decorators.
New in version 0.9.0.
Enable sphinx_toolbox.decorators
by adding the following
to the extensions
variable in your conf.py
:
extensions = [
...
'sphinx_toolbox.decorators',
]
For more information see https://www.sphinx-doc.org/en/master/usage/extensions#third-party-extensions .
Usage¶
API Reference¶
Classes:
|
XRef Role for decorators members. |
Functions:
|
Setup |
-
class
PyDecoXRefRole
(fix_parens=False, lowercase=False, nodeclass=None, innernodeclass=None, warn_dangling=False)[source]¶ Bases:
PyXRefRole
XRef Role for decorators members.
Methods:
process_link
(env, refnode, …)Called after parsing title and target text, and creating the reference node (given in
refnode
).
-
setup
(app)[source]¶ Setup
sphinx_toolbox.decorators
.- Parameters
app (
Sphinx
) – The Sphinx application.- Return type