Adds documentation site#141
Merged
Merged
Conversation
…ion for certain filenames
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## develop #141 +/- ##
========================================
Coverage 93.03% 93.03%
========================================
Files 34 34
Lines 1178 1178
========================================
Hits 1096 1096
Misses 82 82 ☔ View full report in Codecov by Sentry. |
…y, updt .gitignore, trigger deploy on release only
NicolaCourtier
approved these changes
Dec 13, 2023
NicolaCourtier
left a comment
Member
There was a problem hiding this comment.
Really helpful PR! The documentation looks great and the comments are clear and informative. I've added a few minor comments, but overall excellent work bringing the documentation up to scratch, thanks @BradyPlanden!
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
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.
This PR adds a documentation site using sphinx and the pydata-sphinx-theme. To accomplish this, I've updated the docstrings for the package where possible (let me know if I've missed any). As previously discussed, I've relocated the
costsanddatasetfiles to the first level of the package.deploy-docs.yamlnox -s docscostanddatasetclasses topybop/as_costs.pyand_dataset.pypip install -e .[docs]Closes #15. Live site can be viewed at: https://pybop-team.github.io/PyBOP/