sphinx-autoapi is an alternative to autodoc that nonetheless seems to emit the same autodoc-process-docstring event which sphinx-paramlinks listens to, so I thought they might be compatible.
Unfortunately, as shown in a minimal example, half the functionality is broken for docstrings processed by sphinx-autoapi instead of autodoc:
- The parameter documentation itself lacks an HTML ID / is no longer a clickable anchor link.
- References to the parameter are only turned into links if they are qualified with the function name - the parameter itself is not enough even when the references appears in the same docstring as the parameter.
- References via the Sphinx default role don't work at all.
Not sure if this issue would be better solved here or on the sphinx-autoapi side, so I might open an issue about this over there as well.
sphinx-autoapi is an alternative to autodoc that nonetheless seems to emit the same
autodoc-process-docstringevent which sphinx-paramlinks listens to, so I thought they might be compatible.Unfortunately, as shown in a minimal example, half the functionality is broken for docstrings processed by sphinx-autoapi instead of autodoc:
Not sure if this issue would be better solved here or on the sphinx-autoapi side, so I might open an issue about this over there as well.