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.

Sign up for GitHub

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

Jump to bottom

CI: Python Stubs #578

Merged
merged 1 commit into from
Apr 29, 2024
Merged

CI: Python Stubs #578

merged 1 commit into from
Apr 29, 2024

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Apr 10, 2024 •
edited
Loading

Build CI to generate and update .pyi files, which are stub implementations of all pybind11 exposed Python bindings. We can automatically use these stubs for:

  • ipython / Jupyter / IDE auto completion
  • Sphinx autodocs (instead of writing every doc string twice)

Follow-Ups

  • generate and store as a repo secret: git push token? (needed to overwrite push requirements aka required CI)
  • update Sphinx docs
    • update pybind11 strings where less documented than doc page
  • potentially use a GH action workflow (as in pyAMReX) to skip workflows if first build fails (safe CI time)

@ax3l ax3l added component: documentation Docs, readme and manual component: tests examples, tests and benchmarks component: python Python bindings labels Apr 10, 2024
@ax3l ax3l mentioned this pull request Apr 10, 2024
Merged
@ax3l ax3l changed the title CI: Python Stubs [WIP] CI: Python Stubs Apr 10, 2024
@ax3l ax3l changed the title [WIP] CI: Python Stubs CI: Python Stubs Apr 26, 2024
@ax3l
CI: Python Stubs
f92472f 
Build CI to generate and update `.pyi` files, which are stub
implementations of all pybind11 exposed Python bindings. We can
automatically use these stubs for:

- ipython / Jupyter / IDE auto completion
- Sphinx autodocs (instead of writing every doc string twice)
@ax3l ax3l merged commit d0ac2f3 into ECP-WarpX:development Apr 29, 2024
16 checks passed
@ax3l ax3l deleted the ci-stubs branch April 29, 2024 01:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
component: documentation Docs, readme and manual component: python Python bindings component: tests examples, tests and benchmarks
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ax3l