Skip to content

docs reorganization take 3#639

Merged
kushalkolar merged 29 commits intomainfrom
reorg-docs3
Oct 8, 2024
Merged

docs reorganization take 3#639
kushalkolar merged 29 commits intomainfrom
reorg-docs3

Conversation

@kushalkolar
Copy link
Copy Markdown
Member

@kushalkolar kushalkolar commented Oct 7, 2024

Changes to the actual docs:

  • remove all nb examples except for: test_gc, image_widget, quickstart, and zmq
  • move relevant nb examples to the new flat universal examples dir. This included selector tools and line cmap stuff, and a scatter sizes example
  • selector tools and line cmap stuff in gallery, made a new scatter sizes animation example which is simpler
  • fixes a bug with selector tools where the offset on both dimensions were not being used from the parent graphic
  • move all examples from examples/desktop to just examples/
  • qt code-only examples in the examples gallery so that people don't have to dig through the fastplotlib source tree on github to get any examples
  • update main README.md with changes, still need to wait for next push to main and release so that all the links can be updated. We can consolidate more stuff from the readme into the docs later.
  • test pass and docs build

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.

@kushalkolar kushalkolar requested a review from clewis7 as a code owner October 7, 2024 01:19
@kushalkolar
Copy link
Copy Markdown
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 🫠

@fastplotlib fastplotlib deleted a comment from github-actions bot Oct 7, 2024
@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 7, 2024

📚 Docs preview built and uploaded! https://www.fastplotlib.org/ver/reorg-docs3

@kushalkolar
Copy link
Copy Markdown
Member Author

@clewis7 ready for review!

@kushalkolar kushalkolar mentioned this pull request Oct 7, 2024
5 tasks
Copy link
Copy Markdown
Member

@clewis7 clewis7 left a 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 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

qt in examples gallery Reorganize examples

2 participants