-
Notifications
You must be signed in to change notification settings - Fork 9
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
Update Python API reference docs based on latest GraphQL schema #282
Update Python API reference docs based on latest GraphQL schema #282
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #282 +/- ##
=======================================
Coverage 83.71% 83.71%
=======================================
Files 7 7
Lines 565 565
=======================================
Hits 473 473
Misses 92 92
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
Thanks!!
The main contribution of this PR is to update the Python API reference docs with the new classes added in the recent schema change (
TomogramAuthor
andAnnotationFile
).In addition, there are few other documentation related changes.
1. Updated quick start to reflect other API changes (e.g. removing
binning
keyword argument fromdownload_mrcfile
).2. Added the upgrade option to the napari plugin, so that its dependencies (like the Python client in this repo) are upgraded when there is an existing installation.
3. Fixed the examples in the base model so that they work with the current schema.
4. Fixed some typos and small mistakes in the model docstrings.
5. Enforced a version of Sphinx pre v7 to prevent an error when building the HTML docs.
The error is
Reason: UndefinedError("'style' is undefined")
and is likely related to the Sphinx RTD theme not supporting Sphinx v7. The corresponding issue should be fixed for v2 of the theme, but I did not find that to be the case.Related to #278