-
Notifications
You must be signed in to change notification settings - Fork 666
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
Migrate Multipass docs to RTD #3921
Conversation
Signed-off-by: Giulia Zanchi <[email protected]>
Signed-off-by: Giulia Zanchi <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3921 +/- ##
==========================================
- Coverage 89.11% 89.11% -0.01%
==========================================
Files 255 255
Lines 14600 14601 +1
==========================================
Hits 13011 13011
- Misses 1589 1590 +1 ☔ View full report in Codecov by Sentry. |
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.
LGTM @giuliazanchi
Everything seems to work fine and I didn't notice anything broken.
There are a few things I spotted that you might want to consider here or in a future PR, including:
- Amending
conf.py
to add the feedback button - Synchronising tabs on pages with multiple tab blocks
- Removing serial dashes from some page titles and the side nav
- Removing the dropdown for the Tutorial page in the side nav
I didn't go deep into the content of individual pages but there were no notable problems and all the tests seem to be passing.
Thanks for your review, @edibotopic . I've committed your suggested changes!
|
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.
Great work @giuliazanchi and thank you for the review @edibotopic ! When I tried to make run
this on my laptop Ubuntu 24.10 system, I ran into a sphinx issue with locales on my end because my locale for C.UTF-8
on my machine is named C.utf8
instead. I'm not sure which setting is more common, this stackoverflow post asking about the differences between C.UTF-8 and en_us.UTF-8 have answers using both naming conventions seemingly interchangeably.
https://stackoverflow.com/questions/55673886/what-is-the-difference-between-c-utf-8-and-en-us-utf-8-locales
I resolved this by checking how my C.utf8 locale is named with locales -a
, and setting the environment variables with
export LC_ALL=C.utf8
export LANG=C.utf8
I don't think any changes are warranted as a result of this (my desktop Ubuntu system ran make run
with no need to set locale, and the error message from sphinx is very easy to troubleshoot with google or AI) but just one piece of tribal knowledge to remember in case we run into this issue in the future 🙂
Thanks, @levkropp ! It’s a good thing that you noted this issue with locales, I’ll mention it to the upstream project just in case. |
This PR adds the /docs/ folder to the repo, including the documentation files in .md format, all the necessary files to build and render the docs in Sphinx, and the starter pack extension.
To test it out, go into the /docs/ folder and run make clean and then make run, or just make to see the available targets.
This PR replaces #3916 , to get rid of some conflicts.