search

LLNL / Surfactant

Modular framework for file information extraction and dependency analysis to generate accurate SBOMs
MIT License
21 stars 14 forks source link

Generate API pages for documentation website #109

Open nightlark opened 9 months ago

nightlark commented 9 months ago

Once functions have docstrings, it should be possible to generate API pages for the documentation website -- this will be useful for users looking to use Surfactant as a library. Adding a page with a brief intro to library/programmatic use could also be useful.

Moses-Mk commented 2 days ago

Assign me this

nightlark commented 2 days ago

As a side note, https://sphinxcontrib-napoleon.readthedocs.io/en/latest/ might be a starting point for a sphinx extension that can be used to generate the API documentation as part of the ReadTheDocs builds. https://stackoverflow.com/questions/74635207/is-there-a-way-automate-sphinx-apidoc-generation-in-readthedocs has some info on how to get the extra sphinx-apidoc command to run as part of RTD builds.