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

Cleanup Api docs #1688

Merged
merged 13 commits into from
Dec 18, 2024
Merged

Cleanup Api docs #1688

merged 13 commits into from
Dec 18, 2024

Conversation

SpacemanPaul
Copy link
Contributor

@SpacemanPaul SpacemanPaul commented Dec 13, 2024

Reason for this pull request

Cleanup and expansion of the curated API docs.

Proposed changes

  • Improve index API documentation,

  • Fix various autodoc and autosummary issues.

  • Add LineageTree to model documentation

  • Replace lingering reference to DatasetType with Product

  • Fix broken directives in masking

  • Tests added / passed

  • Fully documented, including docs/about/whats_new.rst for all changes


📚 Documentation preview 📚: https://datacube-core--1688.org.readthedocs.build/en/1688/

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.61%. Comparing base (63b65ff) to head (87639ed).
Report is 1 commits behind head on develop-1.9.

Additional details and impacted files
@@             Coverage Diff              @@
##           develop-1.9    #1688   +/-   ##
============================================
  Coverage        85.61%   85.61%           
============================================
  Files              151      151           
  Lines            15526    15526           
============================================
  Hits             13293    13293           
  Misses            2233     2233           

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

docs/api/index.rst Show resolved Hide resolved
docs/installation/extending-odc.rst Outdated Show resolved Hide resolved
docs/installation/extending-odc.rst Outdated Show resolved Hide resolved
@SpacemanPaul SpacemanPaul merged commit 76b7999 into develop-1.9 Dec 18, 2024
30 checks passed
@SpacemanPaul SpacemanPaul deleted the api-docs branch December 18, 2024 05:23
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.

3 participants