We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
abbreviate_signature.py
QRules, AmpForm, and TensorWaves build their API with a small hack: abbreviate_signature.py, which is called through conf.py. This script does two things:
conf.py
The first can be simplified with dict.get. The second can be removed altogether with autodoc_typehints_format = "short", which is available since Sphinx v4.4.0.
dict.get
autodoc_typehints_format = "short"
Warning — Sphinx v4.4.0:
sphinx.domains.python.type_to_xref
See also #59
The text was updated successfully, but these errors were encountered:
Closed by the new sphinx-api-relink extension. See for instance ComPWA/ampform#370.
sphinx-api-relink
Sorry, something went wrong.
redeboer
No branches or pull requests
QRules, AmpForm, and TensorWaves build their API with a small hack:
abbreviate_signature.py
, which is called throughconf.py
. This script does two things:The first can be simplified with
dict.get
. The second can be removed altogether withautodoc_typehints_format = "short"
, which is available since Sphinx v4.4.0.Warning — Sphinx v4.4.0:
sphinx.domains.python.type_to_xref
, which is substituted throughabbreviate_signature.py
here.See also #59
The text was updated successfully, but these errors were encountered: