-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support release-based documentation #4
Comments
Update post some hacking this morning, it can be done and will probably be the solution I go with: quarto-dev/quarto-cli#5851 (comment) Just need to create a version-selector and have its behavior fully mimic HF's |
Approach: check out each branch, cp their docs folder, save to a new folder called |
Forever on the backburner until the course gets done and codenotes v2 is finished, just so I can get that started/going :) If someone wants to pick this up feel free, it however is just a util in a scripts folder outside the main lib, since it relies all on stuff not needed directly in quarto |
Have the
docs/
directory store versioned documentation for each release number andmain
.Should only be seen on the
gh-pages
branch.How huggingface does it: https://huggingface.co/datasets/hf-doc-build/doc-build/tree/main/accelerate
_versions.yml
which points to a release tag.zip
file which can be loaded in (we can just checkout the branch tag or use PyGitHub)/docs/{version_num}
{version_num}
config.yaml
forsemantic_documentation: {truthy}
HF HTML to look from:
Until
v0.1.0
we'll let allv0.0.x
be rendered separately, then combined as true semantic versions once the API is stable enough.Should be placed on the left sidebar, above the page URLs
The text was updated successfully, but these errors were encountered: