Sphinx API documentation framework#11
Conversation
4f53499 to
6a4851d
Compare
|
API Doc looks great! |
This is added now. |
punkduckable
left a comment
There was a problem hiding this comment.
Everything looks good to me.
API reference webpage is automatically built using Sphinx. References used for this PR are:
API website workflow is:
mainbranch. This will check if all the comments in the source directory are written in a proper way.mainbranch, 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.pyshows the example comment according to the numpy style, which is parsed into the API webpage fortiming.py.