Skip to content

docs(py): add versioning to py-rattler documentation#2194

Merged
baszalmstra merged 7 commits intoconda:mainfrom
Anshgrover23:docs/py-rattler-versioning
Mar 11, 2026
Merged

docs(py): add versioning to py-rattler documentation#2194
baszalmstra merged 7 commits intoconda:mainfrom
Anshgrover23:docs/py-rattler-versioning

Conversation

@Anshgrover23
Copy link
Contributor

@Anshgrover23 Anshgrover23 commented Mar 8, 2026 •
edited
Loading

Description

Add versioning support to the py-rattler docs so the header shows a version dropdown

What changed

  • py-rattler/mkdocs.yml: Enabled the mike plugin and version provider so the theme shows a version selector. Versioned docs live under py-rattler/<version>/.

  • py-rattler/pixi.toml: Added mike and the deploy tasks: deploy-dev and deploy-latest.

  • .github/workflows/docs.yaml: Docs are now pushed to the gh-pages branch: main → dev, tags like v0.23.0 → that version + latest. Rustdoc stays at `/``.

image
Screen.Recording.2026-03-11.at.6.39.56.PM.mov

Fixes #1209

How Has This Been Tested?

Tested locally by deploying the dev docs and serving the generated site.

cd rattler/py-rattler
pixi run deploy-dev


cd ..

git checkout gh-pages


python3 -m http.server 8000





go to  http://localhost:8000/

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added sufficient tests to cover my changes.

@Anshgrover23
Copy link
Contributor Author

Anshgrover23 commented Mar 8, 2026

@baszalmstra Could I get a review on this one whenever you get a chance? Thanks.

baszalmstra pushed a commit that referenced this pull request Mar 11, 2026
@claude
fix: address review issues in PR #2194 docs mike configuration
1fb903e 
- Restore root redirect to rattler/index.html (rustdoc) instead of py-rattler/latest/
- Restore rattler/index.html redirect to rattler crate docs
- Move mike plugin after social and before llmstxt (matching pixi/rattler-build ordering)
- Add commented-out mike options as documentation (matching pixi/rattler-build)
- Add "llmstxt must come after mike" comment (matching pixi)
- Set top-level permissions to contents: read, override to write only on deploy jobs
- Remove unnecessary Rust toolchain setup from build-docs PR testing job
- Use consistent --manifest-path invocation instead of working-directory

https://claude.ai/code/session_01ShuA3cWtSWLrQDvWKnMRxc
@baszalmstra
Copy link
Collaborator

baszalmstra commented Mar 11, 2026

I let claude review and fix your PR. Please review if these changes make sense to you.

@Anshgrover23
Copy link
Contributor Author

Anshgrover23 commented Mar 11, 2026 •
edited
Loading

@baszalmstra applied all of Claude’s suggestions.
Reverted the overwrite of rattler/index.html so the real rustdoc index from cargo doc is kept.

Screen.Recording.2026-03-11.at.6.39.56.PM.mov

@baszalmstra baszalmstra merged commit 98a9fca into conda:main Mar 11, 2026
10 checks passed
@baszalmstra
Copy link
Collaborator

baszalmstra commented Mar 11, 2026

Even though this PR is merged it doesnt seem to work properly yet. Can you check why?

@Anshgrover23
Copy link
Contributor Author

Anshgrover23 commented Mar 11, 2026

@baszalmstra The skips are expected, docs-dev ran and deployed.
Please confirm Pages is set to deploy from branch gh-pages, and that release versions will be deployed by pushing tags or running the workflow with a tag.

@baszalmstra
Copy link
Collaborator

baszalmstra commented Mar 11, 2026

Yes Pages is set to deploy from branch gh-pages:

image

@Anshgrover23 Anshgrover23 mentioned this pull request Mar 11, 2026
Open
4 tasks
@Anshgrover23
Copy link
Contributor Author

Anshgrover23 commented Mar 11, 2026 •
edited
Loading

Hey @baszalmstra I tracked down why the docs still weren’t working after this PR got merged.
Opened a follow-up PR with the fix: #2212
After merge, you’ll need to do a new release so latest gets deployed and the redirect works.

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

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add versioning to py-rattler documentation

2 participants

@Anshgrover23 @baszalmstra