Skip to content

[RFC] Use mkdocs-material for Zarr-Python documentation #3118

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

Draft
wants to merge 21 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
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/*.rst`
* [ ] 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)
2 changes: 1 addition & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
needs release notes:
- all:
- changed-files:
- all-globs-to-all-files: '!changes/*.rst'
- all-globs-to-all-files: '!changes/*.md'
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ coverage.xml
# Django stuff:
*.log

# Sphinx documentation
# Documentation
site/
docs/_build/
docs/api
docs/data
data
data.zip
Expand Down
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ repos:
rev: v5.0.0
hooks:
- id: check-yaml
exclude: mkdocs.yml
- id: trailing-whitespace
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.16.1
Expand Down
7 changes: 2 additions & 5 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,8 @@ build:
towncrier build --version Unreleased --yes;
fi

sphinx:
configuration: docs/conf.py
fail_on_warning: true

formats: all
mkdocs:
configuration: mkdocs.yml

python:
install:
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion changes/2874.feature.rst → changes/2874.feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ variable-length string data type, but the old metadata representation can still
used when reading arrays. The logic for automatically choosing the chunk encoding for a given data
type has also changed, and this necessitated changes to the ``config`` API.

For more on this new feature, see the `documentation </user-guide/data_types.html>`_
For more on this new feature, see the [documentation](user-guide/data_types.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion changes/3128.bugfix.rst → changes/3128.bugfix.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Fix `zarr.open` default for argument `mode` when `store` is `read_only`
Fix `zarr.open` default for argument `mode` when `store` is `read_only`.
1 change: 1 addition & 0 deletions changes/3130.feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Port more stateful testing actions from [Icechunk](https://icechunk.io).
1 change: 0 additions & 1 deletion changes/3130.feature.rst

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion changes/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Writing a changelog entry
-------------------------

Please put a new file in this directory named `xxxx.<type>.rst`, where
Please put a new file in this directory named `xxxx.<type>.md`, where

- `xxxx` is the pull request number associated with this entry
- `<type>` is one of:
Expand Down
231 changes: 0 additions & 231 deletions docs/Makefile

This file was deleted.

Loading
Loading