Skip to content

Sphinx API documentation framework#11

Merged
dreamer2368 merged 15 commits into
mainfrom
sphinx
Oct 28, 2024
Merged

Sphinx API documentation framework#11
dreamer2368 merged 15 commits into
mainfrom
sphinx

Conversation

@dreamer2368

@dreamer2368 dreamer2368 commented Oct 17, 2024

Copy link
Copy Markdown
Collaborator

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

API website workflow is:

  • The website will be built (not deployed) for every commit of a PR to main branch. This will check if all the comments in the source directory are written in a proper way.
  • Upon the PR's merging into 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 for timing.py.

@dreamer2368 dreamer2368 force-pushed the sphinx branch 7 times, most recently from 4f53499 to 6a4851d Compare October 17, 2024 17:16
@dreamer2368 dreamer2368 marked this pull request as ready for review October 17, 2024 17:39
@dreamer2368 dreamer2368 added the RFR Ready for Review label Oct 17, 2024
@dreamer2368 dreamer2368 changed the title Sphinx Sphinx API documentation framework Oct 17, 2024
@CBonneville45

Copy link
Copy Markdown
Collaborator

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

Copy link
Copy Markdown
Collaborator Author

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.

@punkduckable punkduckable left a comment

Copy link
Copy Markdown
Collaborator

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.

@dreamer2368 dreamer2368 merged commit 32f1944 into main Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

RFR Ready for Review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants