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

Docs: Python API in the Manual #200

Merged
merged 1 commit into from
Aug 10, 2022
Merged

Docs: Python API in the Manual #200

merged 1 commit into from
Aug 10, 2022

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Aug 8, 2022 •
edited
Loading

Document the Python API in the user-facing manual.

Sphinx Ref.:

To do:

  • add each user-facing class, property & method
  • add docstrings and arguments

Follow-up:

@ax3l ax3l added component: documentation Docs, readme and manual component: python Python bindings labels Aug 8, 2022
@ax3l ax3l force-pushed the doc-python-api branch 5 times, most recently from bb047bb to ad19c57 Compare August 10, 2022 17:43
@ax3l ax3l changed the title [WIP] Docs: Start Documenting Python API Docs: Start Documenting Python API Aug 10, 2022
@ax3l ax3l requested review from n01r and RTSandberg August 10, 2022 18:21
@ax3l ax3l changed the title Docs: Start Documenting Python API Docs: Python API in the Manual Aug 10, 2022
RTSandberg
RTSandberg approved these changes Aug 10, 2022
View reviewed changes
Copy link
Member

@RTSandberg RTSandberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really nice!

@ax3l ax3l merged commit a16ffa9 into ECP-WarpX:development Aug 10, 2022
@ax3l ax3l deleted the doc-python-api branch August 10, 2022 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RTSandberg RTSandberg RTSandberg approved these changes

@n01r n01r Awaiting requested review from n01r

Assignees
No one assigned
Labels
component: documentation Docs, readme and manual component: python Python bindings
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ax3l @RTSandberg