Skip to content

add user guide #513

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.

Sign up for GitHub

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

Merged
kushalkolar merged 10 commits into from
Jun 22, 2024
Merged

add user guide #513

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
35ede8c
start guide based on new API changes
clewis7 Jun 7, 2024
4135480
Update guide.rst
clewis7 Jun 11, 2024
3d153a2
progress on guide
clewis7 Jun 18, 2024
dfa3a1b
guide updates
clewis7 Jun 22, 2024
e3fe161
add spaces and interactive use sections
clewis7 Jun 22, 2024
33eda1e
add selectors to guide
clewis7 Jun 22, 2024
be6a8ea
guide updates
clewis7 Jun 22, 2024
9801eae
rough draft
clewis7 Jun 22, 2024
74db255
Apply suggestions from code review
clewis7 Jun 22, 2024
bda4766
update guide
clewis7 Jun 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/source/_static/guide_animation.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/source/_static/guide_hello_world.png
View file
Open in desktop
Copy link
Copy Markdown
Member

@kushalkolar kushalkolar Jun 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are these auto-generated?

Copy link
Copy Markdown
Member Author

@clewis7 clewis7 Jun 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, pygfx had them as static images stored in their docs so I did the same

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/source/_static/guide_hello_world_data.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/source/_static/guide_hello_world_vmax.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/source/_static/guide_image_widget.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/source/_static/guide_linear_selector.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"pygfx": ("https://pygfx.com/latest", None),
"pygfx": ("https://pygfx.com/stable", None),
Copy link
Copy Markdown
Member

@kushalkolar kushalkolar Jun 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should link to latest

Copy link
Copy Markdown
Member Author

@clewis7 clewis7 Jun 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

before when I had it at latest it failed to build

"wgpu": ("https://wgpu-py.readthedocs.io/en/latest", None),
}

Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Welcome to fastplotlib's documentation!
:caption: User Guide
:maxdepth: 2

Guide <user_guide/guide.rst>
GPU Info <user_guide/gpu>

.. toctree::
Expand Down
497 changes: 497 additions & 0 deletions docs/source/user_guide/guide.rst
View file
Open in desktop

Large diffs are not rendered by default.