Skip to content

Convert RST docs to markdown#830

Merged
maxrjones merged 3 commits intozarr-developers:mainfrom
maxrjones:md-docs
Mar 19, 2026
Merged

Convert RST docs to markdown#830
maxrjones merged 3 commits intozarr-developers:mainfrom
maxrjones:md-docs

Conversation

@maxrjones
Copy link
Member

This PR changes the docs structure to be based on markdown, still via sphinx, using the myst-parser. The goal is to improve maintainability.

Closes #828

TODO:

  • Unit tests and/or doctests in docstrings
  • Tests pass locally
  • Docstrings and API docs for any new/modified user-facing classes and functions
  • Changes documented in docs/release.rst
  • Docs build locally
  • GitHub Actions CI passes
  • Test coverage to 100% (Codecov passes)

@maxrjones maxrjones requested a review from d-v-b March 18, 2026 20:06
@maxrjones maxrjones merged commit 06a53c6 into zarr-developers:main Mar 19, 2026
33 of 38 checks passed
@codecov
Copy link

codecov bot commented Mar 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.33%. Comparing base (456a3e1) to head (a26bbbe).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #830   +/-   ##
=======================================
  Coverage   99.33%   99.33%           
=======================================
  Files          26       26           
  Lines         898      898           
=======================================
  Hits          892      892           
  Misses          6        6           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

Convert restructured text docs to markdown

2 participants