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

Python stubs are not generated correctly #640

Closed
ikanago opened this issue May 10, 2024 · 0 comments · Fixed by #643
Closed

Python stubs are not generated correctly #640

ikanago opened this issue May 10, 2024 · 0 comments · Fixed by #643
Labels
bug Something isn't working documentaiton Documentaiton issues

Comments

@ikanago
Copy link
Contributor

ikanago commented May 10, 2024

In #620, we remove Python stubs from this repository and generate them every time to build the doc.
But the API document for qulacs.* submodule is not generated correctly(link).

Before #620, the stubs for a submodule is written in, for example, pysrc/qulacs/circuit/__init__.pyi.
But now ./script/update_stubs.sh(internally stubgen and pybind11-stubgen) generates the stubs in pysrc/qulacs/circuit.pyi, which seems to be ignored by Sphinx(and its plugin).

So we have to

  • find any options of stubgen to generate the stubs in pysrc/qulacs/***/__init__.pyi
  • rename generated files to desired ones as a workaround
@KowerKoint KowerKoint added bug Something isn't working documentaiton Documentaiton issues labels May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentaiton Documentaiton issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants