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

Add documentation for the CUPiD API #73

Open
TeaganKing opened this issue Mar 6, 2024 · 1 comment
Open

Add documentation for the CUPiD API #73

TeaganKing opened this issue Mar 6, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation hackathon (possibly more in depth) hackathon

Comments

@TeaganKing
Copy link
Collaborator

We'd like to include documentation for the code within the CUPiD API. This can be automatically generated and updated with sphinx. We may also want to consider pydoc or other tools.
@mnlevy1981 mnlevy1981 mentioned this issue Mar 6, 2024
Closed
@TeaganKing TeaganKing added the documentation Improvements or additions to documentation label Mar 6, 2024
@TeaganKing
Copy link
Collaborator Author

@rmshkv mentioned that "We should also include some more extensive documentation for people developing notebooks about including the serial parameter and logic with the local cluster, maybe in a separate page about parallelization."

@TeaganKing TeaganKing mentioned this issue Mar 8, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation hackathon (possibly more in depth) hackathon
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@TeaganKing