-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds documentation site #141
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 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
costs
anddataset
files to the first level of the package.deploy-docs.yaml
nox -s docs
cost
anddataset
classes topybop/
as_costs.py
and_dataset.py
pip install -e .[docs]
Closes #15. Live site can be viewed at: https://pybop-team.github.io/PyBOP/