You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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/
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 file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.