Skip to content
Merged
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
15 changes: 14 additions & 1 deletion packages/zarr-http-server/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,20 @@ build:
- pip install ./packages/zarr-http-server --group packages/zarr-http-server/pyproject.toml:docs
build:
html:
- mkdocs build --strict -f packages/zarr-http-server/mkdocs.yml --site-dir $READTHEDOCS_OUTPUT/html
# Build from inside the package rather than pointing `-f` at its config
# from the repo root. mkdocs resolves some settings relative to the
# current working directory rather than to the config file, so building
# from elsewhere looks for them in the wrong place -- and silently, since
# the paths are valid, just wrong. zarr-indexing hit this: with
# `pymdownx.snippets` and a relative `base_path`, its snippets were
# searched for under the repo-root docs/ and the build failed with
# SnippetMissingError, while `just docs-check` passed because it runs
# from here. Building from the package directory makes this identical to
# the local and CI invocations, so a green build there means a green
# build here.
#
# $READTHEDOCS_OUTPUT is absolute, so the cd does not affect it.
- cd packages/zarr-http-server && mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html

mkdocs:
configuration: packages/zarr-http-server/mkdocs.yml
15 changes: 14 additions & 1 deletion packages/zarr-indexing/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,20 @@ build:
- pip install ./packages/zarr-indexing --group packages/zarr-indexing/pyproject.toml:docs
build:
html:
- mkdocs build --strict -f packages/zarr-indexing/mkdocs.yml --site-dir $READTHEDOCS_OUTPUT/html
# Build from inside the package rather than pointing `-f` at its config
# from the repo root. mkdocs resolves some settings relative to the
# current working directory rather than to the config file, so building
# from elsewhere looks for them in the wrong place -- and silently, since
# the paths are valid, just wrong. zarr-indexing hit this: with
# `pymdownx.snippets` and a relative `base_path`, its snippets were
# searched for under the repo-root docs/ and the build failed with
# SnippetMissingError, while `just docs-check` passed because it runs
# from here. Building from the package directory makes this identical to
# the local and CI invocations, so a green build there means a green
# build here.
#
# $READTHEDOCS_OUTPUT is absolute, so the cd does not affect it.
- cd packages/zarr-indexing && mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html

mkdocs:
configuration: packages/zarr-indexing/mkdocs.yml
15 changes: 14 additions & 1 deletion packages/zarr-metadata/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,20 @@ build:
- pip install ./packages/zarr-metadata --group packages/zarr-metadata/pyproject.toml:docs
build:
html:
- mkdocs build --strict -f packages/zarr-metadata/mkdocs.yml --site-dir $READTHEDOCS_OUTPUT/html
# Build from inside the package rather than pointing `-f` at its config
# from the repo root. mkdocs resolves some settings relative to the
# current working directory rather than to the config file, so building
# from elsewhere looks for them in the wrong place -- and silently, since
# the paths are valid, just wrong. zarr-indexing hit this: with
# `pymdownx.snippets` and a relative `base_path`, its snippets were
# searched for under the repo-root docs/ and the build failed with
# SnippetMissingError, while `just docs-check` passed because it runs
# from here. Building from the package directory makes this identical to
# the local and CI invocations, so a green build there means a green
# build here.
#
# $READTHEDOCS_OUTPUT is absolute, so the cd does not affect it.
- cd packages/zarr-metadata && mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html

mkdocs:
configuration: packages/zarr-metadata/mkdocs.yml
Loading