Repository navigation
Fix the documentation root redirect - #102
Merged
Marenz merged 1 commit intoOct 5, 2026
Merged
Conversation
The publish-docs CI job never calls `mike set-default`, so the gh-pages branch has no root index.html and https://frequenz-floss.github.io/frequenz-client-marketmetering-python/ returns a plain GitHub Pages 404. The README and pyproject.toml Documentation link both point at that root URL. Add a `mike set-default latest` call right after `mike deploy` in the publish-docs job, mirroring what the test-docs job already does for its ephemeral build. Using the `latest` alias (rather than the version computed for the current CI run) keeps the site default tied to the latest stable release, so pushes that only publish a -dev build never make a dev snapshot the default. Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
github-actions
Bot
added
the
part:tooling
llucax
reviewed
Oct 7, 2026
| # Make sure the site root (gh-pages index.html) redirects to the | ||
| # `latest` alias. Without this, the documentation website root URL | ||
| # 404s, as `mike deploy` alone never creates that redirect. | ||
| python -I "$(command -v mike)" set-default latest |
Contributor
There was a problem hiding this comment.
This need to be done only once, no need to put it in the CI, you just missed some setup steps. Recommend reverting so you don't diverge from the repo-config templates unnecessarily, it can break future migration scripts affecting this part.
Contributor
Author
There was a problem hiding this comment.
Right, it was already applied once on gh-pages. Reverted in #103.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Make the documentation root redirect to
latestafter publication. The advertised root currently returns 404 while versioned docs work.