-
Notifications
You must be signed in to change notification settings - Fork 3
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
Sphinx API documentation framework #11
Conversation
4f53499
to
6a4851d
Compare
API Doc looks great! |
This is added now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything looks good to me.
API reference webpage is automatically built using Sphinx. References used for this PR are:
API website workflow is:
main
branch. This will check if all the comments in the source directory are written in a proper way.main
branch, the website will be deployed public to software.llnl.gov/GPLaSDI/For documenting style, we will follow the numpy style:
https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html
src/lasdi/timing.py
shows the example comment according to the numpy style, which is parsed into the API webpage fortiming.py
.