Skip to content

Use mkdocs-material for documentation#615

Merged
maxrjones merged 17 commits into
developfrom
update-docs
Jun 18, 2025
Merged

Use mkdocs-material for documentation#615
maxrjones merged 17 commits into
developfrom
update-docs

Conversation

@maxrjones
Copy link
Copy Markdown
Member

@maxrjones maxrjones commented Jun 16, 2025

Updates documentation from sphinx to mkdocs.

FYI @norlandrhagen the update-docs branch is a clean version, so I recommend building off this.

  • Closes Use mkdocs-material instead of sphinx #500
  • Tests added
  • Tests passing
  • Full type hint coverage
  • Changes are documented in docs/releases.rst
  • New functions/methods are listed in api.rst
  • New functionality has documentation

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.05%. Comparing base (fdd38ca) to head (b4dd75b).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #615   +/-   ##
========================================
  Coverage    88.05%   88.05%           
========================================
  Files           32       32           
  Lines         1783     1783           
========================================
  Hits          1570     1570           
  Misses         213      213           
Files with missing lines Coverage Δ
virtualizarr/accessor.py 96.07% <ø> (ø)
virtualizarr/manifests/array.py 81.11% <ø> (ø)
virtualizarr/manifests/manifest.py 88.88% <ø> (ø)
virtualizarr/xarray.py 85.57% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@TomNicholas TomNicholas added the documentation Improvements or additions to documentation label Jun 17, 2025
@maxrjones
Copy link
Copy Markdown
Member Author

@TomNicholas would you consider reviewing and merging this as-is? I'm not excited about future merge conflicts and would rather you work off the mkdocs structure for #619. @norlandrhagen could continue to build the migration guide as a separate PR.

Copy link
Copy Markdown
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

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

I'm not excited about future merge conflicts

I don't want to cause more work for you by merging things in an unhelpful order. But this PR also doesn't seem ready to merge yet.

Comment thread docs/index.md Outdated
Comment thread docs/index.md
Comment thread docs/index.md
Comment thread docs/installation.md Outdated
Comment thread docs/installation.md
Comment thread docs/migration_guide.md Outdated
Comment thread docs/usage.md
Comment thread pyproject.toml Outdated
Comment thread pyproject.toml Outdated
@maxrjones maxrjones mentioned this pull request Jun 17, 2025
7 tasks
@maxrjones maxrjones requested a review from TomNicholas June 17, 2025 21:39
@TomNicholas TomNicholas added the CI Continuous Integration label Jun 18, 2025
Copy link
Copy Markdown
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

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

Thanks for making those changes @maxrjones - this is looking beautiful! LGTM

Comment thread docs/releases.md
Co-authored-by: Tom Nicholas <tom@earthmover.io>
@maxrjones maxrjones merged commit e0b2f15 into develop Jun 18, 2025
12 checks passed
@maxrjones maxrjones deleted the update-docs branch June 18, 2025 12:43
@maxrjones
Copy link
Copy Markdown
Member Author

@norlandrhagen sorry for the hassle - here's the commit with your changes to make it slightly easier for you to move it to a different PR cda46c7 (#615)

Comment thread mkdocs.yml
signature_crossrefs: true

inventories:
- https://docs.python.org/3/objects.inv
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@kylebarron
Copy link
Copy Markdown
Contributor

I'd also suggest adding a CI step that ensures your docs build doesn't have any warnings: https://github.com/developmentseed/obstore/blob/ec7dd298f62bf48a23dd677d3780540ece883bfb/.github/workflows/test-python.yml#L73-L76

This ensures that all links are valid

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI Continuous Integration documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use mkdocs-material instead of sphinx

4 participants