Closed dreamer2368 closed 1 week ago
API Doc looks great! Minor note: On the Sphinx API page, I'd suggest adding our LaSDI review paper among the references (https://arxiv.org/abs/2403.10748). Since it's essentially a unified summary of all (currently existing) LaSDI building blocks (as of March 2024), it would be a helpful ressource for prospective users of the library
API Doc looks great! Minor note: On the Sphinx API page, I'd suggest adding our LaSDI review paper among the references (https://arxiv.org/abs/2403.10748). Since it's essentially a unified summary of all (currently existing) LaSDI building blocks (as of March 2024), it would be a helpful ressource for prospective users of the library
This is added now.
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
.