GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — docs reorganization take 3 by kushalkolar · Pull Request #639 · fastplotlib/fastplotlib

Conversation

@kushalkolar

@kushalkolar kushalkolar commented Oct 7, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
kushalkolar added 3 commits October 6, 2024 21:18
@kushalkolar
misc -> misc-dev
fd725c7
@kushalkolar
remove empty README file
8e8dab3
@kushalkolar
examples/desktop -> examples
bdbc726
@kushalkolar
kushalkolar requested a review from clewis7 as a code owner October 7, 2024 01:19
@kushalkolar

kushalkolar commented Oct 7, 2024

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 🫠

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

kushalkolar added 23 commits October 6, 2024 21:25
@kushalkolar
update examples
a352f02
@kushalkolar
remove old nb example stuff
e143a28
@kushalkolar
set offset for both dims for selectors
b72798a
@kushalkolar
update actions
710eb60
@kushalkolar
rename lint -> black
6cbf89d
@kushalkolar
update docs to use pydata sphinx theme and switcher
b542d7b
@kushalkolar
update toctrees w.r.t pydata theme
94423e6
@kushalkolar
update deploy docs to deploy to version dir
3bd0507
@kushalkolar
fix github var name
a74be6d
@kushalkolar
update headings
cf4c0f0
@kushalkolar
update links and homepage
636ced2
@kushalkolar
tryign to learn github actions properly blargh
9f29e8c
@kushalkolar
add a /
906de1b
@kushalkolar
update docs deploy
c302bad
@kushalkolar
update readme and guide
15780ba
@kushalkolar
update readme
51b2ffc
@kushalkolar
comments in workflow
159d246
@kushalkolar
force fail if there are doc build warnings
a5fba0c
@kushalkolar
update job name
15be1d4
@kushalkolar
no longer need separate doc CI test
44cc6d1
@kushalkolar
fix headings
5755865
@kushalkolar
activate minigalleries
7f29f33
@kushalkolar
comment on PR with link to built docs
5e9c34c
@fastplotlib fastplotlib deleted a comment from github-actions Bot Oct 7, 2024
@kushalkolar
proper link
cfe391e
@kushalkolar
update intersphinx for fastplotlib
a498c08
@github-actions

github-actions Bot commented Oct 7, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@kushalkolar
remove fastplotlib from intersphinx inventory for now
df7a157
@kushalkolar

kushalkolar commented Oct 7, 2024

Copy link
Copy Markdown
Member Author

@clewis7 ready for review!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@kushalkolar kushalkolar mentioned this pull request Oct 7, 2024
update contributing guide #580
Closed
5 tasks done
clewis7
clewis7 approved these changes Oct 8, 2024
View reviewed changes

@clewis7 clewis7 left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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 :)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@kushalkolar
kushalkolar merged commit 56abbd9 into main Oct 8, 2024
This was referenced Oct 9, 2024
sphinx mini-galleries #625
Closed
sphinx gallery has a memory leak #626
Closed
Use github actions to deploy to rtd #628
Closed
@kushalkolar
kushalkolar deleted the reorg-docs3 branch October 12, 2024 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@clewis7 clewis7 clewis7 approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

qt in examples gallery Reorganize examples

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@kushalkolar @clewis7
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.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.