Enhance docs#69
Merged
Merged
Conversation
browser was complaining the `tune` and `params` variables were already defined, this way we get around that
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #69 +/- ##
==========================================
+ Coverage 92.00% 92.32% +0.31%
==========================================
Files 9 9
Lines 1339 1342 +3
==========================================
+ Hits 1232 1239 +7
+ Misses 107 103 -4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
and parameter docs there too
so you can see the whole thing on mobile seems that abcjs is computing bottom padding as a percentage of the parent, so too much padding below until adding a parent div with max-width set
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enriches documentation and examples across the codebase and refines the ABCJS display logic in the Tune class.
- Added examples, cross-references, and detailed parameter/docs in source module docstrings.
- Expanded Jupyter notebooks with new content and introduced a
plots.ipynbexample. - Updated Sphinx/ReadTheDocs configuration: added
matplotlib, custom CSS, static path, and doctest support.
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Added matplotlib to the doc extras. |
| pyabc2/sources/*.py | Enhanced docstrings with examples, “See Also” links, notes. |
| pyabc2/parse.py | Updated _FMT_ABCJS_RENDER_JS to include scale and responsive parameters. |
| docs/index.md | Added figure directive alt text and an empty nb-exec-table. |
| docs/examples/*.ipynb | Revamped notebooks with richer examples and added plots.ipynb. |
| docs/conf.py | Enabled custom static path and CSS. |
| .readthedocs.yaml | Added sources to extra requirements. |
| .github/workflows/ci.yml | Enabled --doctest-modules in pytest run configuration. |
Comments suppressed due to low confidence (4)
.readthedocs.yaml:14
- The
sourcesextra is referenced in.readthedocs.yamlbut there is no correspondingsourcesentry under[project.optional-dependencies]inpyproject.toml, which may cause installation failures on ReadTheDocs.
- sources
docs/index.md:26
- [nitpick] The
{nb-exec-table}directive is empty and may not render as intended; consider specifying which notebooks to include or removing it if it’s unused.
```{nb-exec-table}
pyabc2/sources/norbeck.py:301
- [nitpick] The See Also section references the generic
pyabc2.sources.load_url; it would be clearer to referencenorbeck.load_urldirectly.
pyabc2.sources.load_url
pyabc2/parse.py:137
- New ABCJS rendering parameters (
scaleandresponsive) were introduced but there are no tests or doctest examples forTune._repr_html_; consider adding a test to validate correct escaping and output format.
ABCJS.renderAbc("notation-{notation_id:s}", "{abc:s}", {{ scale: 0.87, responsive: "resize" }});
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.
More xrefs, more text and examples, improve robustness of
Tuneabcjs display, introduce plot examples (including the polar plot finally)