Merged
Conversation
Member
Author
|
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 |
Member
Author
|
@clewis7 ready for review! |
clewis7
approved these changes
Oct 8, 2024
This was referenced Oct 9, 2024
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes to the actual docs:
examples/desktopto 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.jsonfile 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.