LLNL / GPLaSDI

http://software.llnl.gov/GPLaSDI/
MIT License
32 stars 3 forks source link

Sphinx API documentation framework #11

Closed dreamer2368 closed 1 week ago

dreamer2368 commented 2 weeks ago

API reference webpage is automatically built using Sphinx. References used for this PR are:

API website workflow is:

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 for timing.py.

CBonneville45 commented 2 weeks 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

dreamer2368 commented 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

This is added now.