Skip to content

DOC: zarr-http-server docs are incomplete, missing guide.md #4291

Closed

Description

@psobolewskiPhD

Describe the issue linked to the documentation

The docs for zarr-http-server are incomplete. For example, the README and /docs mention a guide (and there is a /docs/guide.md), but the link is broken and it doesn't appear to be accessible via the docs site.

Working, appears to be index.md:
https://zarr.readthedocs.io/projects/zarr-http-server/en/latest/

Not working, linked as user guide in the README:
https://zarr.readthedocs.io/projects/zarr-http-server/en/latest/guide/

Suggested fix for documentation

Please update or rebuild the docs site to include the new page?

Activity

  1. added
    help wantedIssue could use help from someone with familiarity on the topic
    documentationImprovements to the documentation
    on Aug 26, 2026
  2. psobolewskiPhD commented on Aug 26, 2026

    @psobolewskiPhD
    Author

    Note: /stable/ confusingly redirects to zarr-python docs?
    https://zarr.readthedocs.io/projects/zarr-http-server/en/stable/

    So something must be up with the deployment of the docs?

  3. d-v-b commented on Aug 26, 2026

    @d-v-b
    Contributor

    Thanks for the report, I'll get fixed in shortly! No clue what's up with RTD latest, I might have to learn more about our RTD configuration

  4. psobolewskiPhD commented on Aug 26, 2026

    @psobolewskiPhD
    Author

    No rush, the .md is perfectly fine for me. Just wanted to let y'all know!

  5. d-v-b commented on Aug 26, 2026

    @d-v-b
    Contributor

    so the underlying issue is that RTD simply can't do a stable page for subpackages. It chooses a commit for stable based on the most recent semver-like tag, which will be tags for zarr releases (not what we want for zarr-http-server!). Without a way to customize the tag pattern RTD looks for, we have to simply disable the stable version entirely. So i've done that. I also switched zarr-python to use the RTD github app, which unblocked the thing preventing the latest docs page from working. So next I need to make redirects from stable to latest.

    with that I think this can be closed? LMK if I need to re-open it.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topic

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions