-
Notifications
You must be signed in to change notification settings - Fork 50
docs reorganization take 3 #639
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
Conversation
ok great the iris file has stayed on lfs, no nonsense conflicts, will pick the rest of the files from the other branch 🫠 |
📚 Docs preview built and uploaded! https://www.fastplotlib.org/ver/reorg-docs3 |
@clewis7 ready for review! |
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.
Docs look amazing :DDDD
Will rebase the contrib PR after this is merged and finish that up this week! Should have more time to work on fpl stuff after I submit NSF stuff next week :)
Changes to the actual docs:
examples/desktop
to justexamples/
closes #624, closes #564
Changes to CI/CD:
We're now hosting docs on our own. They are built with github actions since RTD has a very low limit of 7GB which we are hitting despite sphinx-build only taking a max of ~1.25GB when I build locally 🤷♂️ .
So the docs are built on github actions and then uploaded to our file host via FTP. This is the action we're using to upload: https://github.com/SamKirkland/FTP-Deploy-Action
Switched to pydata-sphinx-theme since it has built-in support for versioning: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html . The MNE Project is a good resource to see how to implement it: https://github.com/mne-tools/mne-python/tree/main/doc
Basically we can push to different subdirs on our host and the dropdown switcher can point to those various subdirs. I think we can test it properly and make any changes once we do a release. The action we're using supports uploading the docs to specific subdirs. There's a
switcher.json
file which we has to be populated with the names and links to each version, but we can automate generating that after the next release.For our own use, the same action will also upload to a subdir based on the PR name that we can use to see what the built docs look like online. The PR builds won't be available in the dropdown menu but we can access them like this:
fastplotlib.org/ver/pr-name
. I also made it so a github actions will add a comment to the PR with a link to the docs built from the PR after they're built and uploaded :D. You can see the workflow yaml, it's pretty simple.