Use mkdocs-material for documentation#615
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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
🚀 New features to boost your workflow:
|
|
@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. |
TomNicholas
left a comment
There was a problem hiding this comment.
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.
TomNicholas
left a comment
There was a problem hiding this comment.
Thanks for making those changes @maxrjones - this is looking beautiful! LGTM
Co-authored-by: Tom Nicholas <tom@earthmover.io>
|
@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 |
| signature_crossrefs: true | ||
|
|
||
| inventories: | ||
| - https://docs.python.org/3/objects.inv |
There was a problem hiding this comment.
You should add cross linking for all your dependencies:
- https://docs.xarray.dev/en/stable/objects.inv
- https://numpy.org/doc/stable/objects.inv
- https://numcodecs.readthedocs.io/en/stable/objects.inv
- https://zarr.readthedocs.io/en/stable/objects.inv
- https://developmentseed.org/obstore/latest/objects.inv
I'd also suggest adding cross linking for your optional dependencies
|
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 |
Updates documentation from sphinx to mkdocs.
FYI @norlandrhagen the update-docs branch is a clean version, so I recommend building off this.
docs/releases.rstapi.rst