-
Notifications
You must be signed in to change notification settings - Fork 85
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
documentation: deploy docs website to readthedocs #4043
Conversation
One more thing is that we can still use gh pages for something else if we decide to host on readthedocs, not sure that the current jupyterlite page is what we want, but it can stay up a little bit longer while we decide. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4043 +/- ##
=======================================
Coverage 90.23% 90.23%
=======================================
Files 458 458
Lines 58409 58409
Branches 5691 5691
=======================================
Hits 52707 52707
Misses 4320 4320
Partials 1382 1382 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Navigation could use some work, but that's a great start!
- asdf plugin add uv | ||
- asdf install uv latest | ||
- asdf global uv latest | ||
- VENV_EXTRAS="--all-extras" VENV_DIR="$READTHEDOCS_VIRTUALENV_PATH" make venv |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had to look up https://docs.readthedocs.com/platform/stable/reference/environment-variables.html#envvar-READTHEDOCS_VIRTUALENV_PATH. Not sure if it's worth adding it as a comment in similar fashion to the existing comment above.
This PR sets up readthedocs hosting for our mkdocs docs, meaning we get the best of both worlds:
Check it out here:
https://xdsl.readthedocs.io/en/latest/
We definitely want to clean it up and make it nicer before making public announcements but it seems like a big step forwards.