Adding documentation and updated licence to Apache 2.0 #44
Conversation
This file contains 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
Collaborator
anchal-physics
commented
May 1, 2024
anchal-physics
commented
- make_docs workflow has been added to generate online documentation from source code
- docstrings were added and edited for succesfull generation of documentation.
- Licence has been changed to Apache 2.0 with a Notice file to cite proceedings in PSI 2024 for academic publications.
* make_docs workflow has been added to generate online documentation * docstrings have been added and edited to make the documentation more informative and clear.
Co-authored-by: Orso Meneghini <orso82@gmail.com>
eldond
approved these changes
May 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.