Skip to content
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

Merged
merged 24 commits into from
Dec 14, 2023
Merged

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Dec 11, 2023

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 and dataset files to the first level of the package.

  • Update docstrings across the package for correct rendering in sphinx (should align with PEP-0257)
  • Add a deployment workflow: deploy-docs.yaml
  • Add a nox session for live-editting of the docs: nox -s docs
  • Moves cost and dataset classes to pybop/ as _costs.py and _dataset.py
  • Adds a pip installation flag for docs: pip install -e .[docs]
  • Update changelog.md and contributing.md

Closes #15. Live site can be viewed at: https://pybop-team.github.io/PyBOP/

@BradyPlanden BradyPlanden linked an issue Dec 11, 2023 that may be closed by this pull request
Copy link

codecov bot commented Dec 11, 2023

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Comparison is base (707f16a) 93.03% compared to head (af10b31) 93.03%.
Report is 8 commits behind head on develop.

❗ Current head af10b31 differs from pull request most recent head a0d44e5. Consider uploading reports for the commit a0d44e5 to get more accurate results

Files Patch % Lines
pybop/_dataset.py 63.63% 4 Missing ⚠️
pybop/optimisers/base_optimiser.py 0.00% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

…y, updt .gitignore, trigger deploy on release only
docs/conf.py Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@NicolaCourtier NicolaCourtier left a 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!

@BradyPlanden BradyPlanden merged commit de864da into develop Dec 14, 2023
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create documentation for PyBOP
2 participants