rustworkx icon indicating copy to clipboard operation
rustworkx copied to clipboard

Incorporate type annotations in docs

Open IvanIsCoding opened this issue 10 months ago • 0 comments

What is the expected enhancement?

In short, this enhancement consits of two tasks

Re-enable signature for methods with singledispatch

Undo the work in #606. https://github.com/Qiskit/qiskit_sphinx_theme/issues/21 was closed a while ago, we need to check if our theme version contains the fix but the answer is probably yes.

I firmly believe this is just editing https://github.com/IvanIsCoding/rustworkx/blob/08c21ece6510171615d358352dd2933ca3494fc8/docs/source/conf.py#L161 to revert #606

Use type annotations to enrich our docs

Currently, we have .pyi stubs with annotations that are not reflected in our docs. This is a missed opportunity, as we have put quite a lot of work on them to make pylance/pyright/VScode and mypy work well with rustworkx.

This might be possible now that https://github.com/sphinx-doc/sphinx/pull/13253 got merged. Of course, that might not be released or might only be available in the last version of Sphinx. But we should explore

IvanIsCoding avatar Apr 11 '25 00:04 IvanIsCoding