-
Notifications
You must be signed in to change notification settings - Fork 1
Initial docs #68
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
Initial docs #68
Conversation
Furo doesn't do it automatically like book theme does
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #68 +/- ##
==========================================
+ Coverage 89.50% 90.02% +0.51%
==========================================
Files 9 9
Lines 1334 1333 -1
==========================================
+ Hits 1194 1200 +6
+ Misses 140 133 -7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
seems like only the first Tune instance gets rendered in the docs rendering of the nb
which uses abcjs via IPython display
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.
Pull Request Overview
This PR sets up the initial documentation infrastructure for PyABC2, enriches core classes with docstrings, adds example notebooks, and updates CI to build and test those docs.
- Add
docextras topyproject.tomland create Sphinx config (docs/conf.py,.readthedocs.yaml,docs/api.rst,docs/index.md). - Populate core modules (
pitch.py,note.py,key.py,parse.py) with detailed docstrings. - Move example notebooks under
docs/examplesand update CI workflow to execute them.
Reviewed Changes
Copilot reviewed 15 out of 16 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/test_note.py | Extend parametric test for unimplemented methods |
| pyproject.toml | Add doc dependency group |
| pyabc2/pitch.py | Add missing docstrings for various methods |
| pyabc2/note.py | Add docstrings and stubs for conversion methods |
| pyabc2/parse.py | Add docstring for measures and repr, adjust HTML |
| pyabc2/key.py | Enhance class and constructor docstrings |
| docs/conf.py | Sphinx project configuration |
| docs/index.md | Landing page for documentation |
| docs/api.rst | Autosummary setup for API |
| docs/examples/* | Initial example notebooks with headings |
| .readthedocs.yaml | ReadTheDocs build configuration |
| .github/workflows/ci.yml | Run notebooks from docs/examples |
Comments suppressed due to low confidence (1)
pyabc2/note.py:288
- This stub
from_namedefinition overrides the actual implementation earlier in the class, breaking parsing functionality. Remove these duplicate stubs or rename them so you don't shadow the real constructors.
def from_name(cls, *args, **kwargs):
No description provided.