Skip to content

(zarr-metadata/zarr-indexing) document RTD slug quirks #4236

Description

@d-v-b

as explored in #Zarr-Python > ✔ zarr-metadata docs, getting ReadTheDocs (RTD) to use the correct slug for subpackage docs pages like zarr-metadata.readthedocs.io/en/v0.4.0 is not obvious. RTD treats every git tag as a separate version, and it automatically assigns slugs to each version based on the tag. Conventionally, subpackages use a templated tag like zarr_metadata-v0.4.0 to encode the version string v0.4.0. RTD by default assigns the slug v0.4.0 to the commit tagged v0.4.0, which was an old zarr release, not a zarr-metadata release. Attempting to use the slug v0.4.0 for the zarr-metadata release tagged zarr_metadata-v0.4.0 will be blocked by RTD, as the v0.4.0 tag is claimed. The fix: select the v0.4.0 version in the RTD admin page for the subpackage docs and set its slug to something unused, like xv0.4.0. This releases the v0.4.0 slug, which can then be associated with the zarr_metadata-v0.4.0 tag.

we should explain this process in the release docs for subpackages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    zarr-metadataSpecific to the zarr-metadata sub-package

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions