Skip to content

chore: CI worfklows for linting docs#4076

Open
maxrjones wants to merge 4 commits into
zarr-developers:mainfrom
maxrjones:chore/test-docs-formatting
Open

chore: CI worfklows for linting docs#4076
maxrjones wants to merge 4 commits into
zarr-developers:mainfrom
maxrjones:chore/test-docs-formatting

Conversation

@maxrjones

Copy link
Copy Markdown
Member

This PR adds a couple scripts that run in the docs workflow to:

  • Check that all top-level functions are included in the mkdocs API documentation
  • Check that docstrings use mkdocs rather than sphinx styles admonitions and links

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@github-actions github-actions Bot added the needs release notes Automatically applied to PRs which haven't added release notes label Jun 17, 2026
@maxrjones maxrjones changed the title chore: CI worfklows for missing docs and RST docstrings chore: CI worfklows for linting docs Jun 17, 2026
@maxrjones

Copy link
Copy Markdown
Member Author

@d-v-b @chuckwondo this adds a fair amount of config/workflow files, so a review on the direction here would be welcome but not necessarily required

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

Labels

needs release notes Automatically applied to PRs which haven't added release notes tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant