Skip to content
New issue

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

Simplify abbreviate_signature.py script #58

Closed
redeboer opened this issue Jan 18, 2022 · 1 comment
Closed

Simplify abbreviate_signature.py script #58

redeboer opened this issue Jan 18, 2022 · 1 comment
Assignees
Labels
📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience

Comments

@redeboer
Copy link
Member

redeboer commented Jan 18, 2022

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:

  1. It remaps broken intersphinx links.
  2. It abbreviates types in signatures.

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.

Warning — Sphinx v4.4.0:

See also #59

@redeboer redeboer added 📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience labels Jan 18, 2022
@redeboer redeboer self-assigned this Jan 18, 2022
@redeboer redeboer transferred this issue from ComPWA/compwa.github.io Apr 25, 2022
@redeboer
Copy link
Member Author

redeboer commented Dec 4, 2023

Closed by the new sphinx-api-relink extension. See for instance ComPWA/ampform#370.

@redeboer redeboer closed this as completed Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience
Projects
None yet
Development

No branches or pull requests

1 participant