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

Update Python API reference docs based on latest GraphQL schema #282

Merged
merged 8 commits into from
Dec 14, 2023

Conversation

andy-sweet
Copy link
Contributor

@andy-sweet andy-sweet commented Dec 14, 2023

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 and AnnotationFile).

In addition, there are few other documentation related changes.

1. Updated quick start to reflect other API changes (e.g. removing binning keyword argument from download_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

@andy-sweet andy-sweet changed the title Update API reference docs based on latest schema Update API reference docs based on latest GraphQL schema Dec 14, 2023
@andy-sweet andy-sweet changed the title Update API reference docs based on latest GraphQL schema Update Python API reference docs based on latest GraphQL schema Dec 14, 2023
Copy link

codecov bot commented Dec 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (78934ec) 83.71% compared to head (9d8f1ef) 83.71%.
Report is 6 commits behind head on main.

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           
Flag Coverage Δ
unittests 83.71% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@andy-sweet andy-sweet marked this pull request as ready for review December 14, 2023 22:42
Copy link
Contributor

@jgadling jgadling left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!!

@andy-sweet andy-sweet merged commit 8c6cb98 into chanzuckerberg:main Dec 14, 2023
12 of 13 checks passed
@andy-sweet andy-sweet deleted the docs-update-api-refs branch December 14, 2023 22:59
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.

2 participants