Skip to content

Consider switching to sphinx-autodoc2

Python recommends to switch to annotations evaluated only as necessary by using from __future__ import annotations. This, unfortunately, breaks automatic docstrings because they rely on annotations being evaluated. We should consider using an alternative approach, for example by using https://sphinx-autodoc2.readthedocs.io/. It would also allow us to write the docstrings in myst, which is more readable than rst.

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information