Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

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.

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
merged 10 commits into from
Jun 22, 2024
Merged

add user guide #513

merged 10 commits into from
Jun 22, 2024

Conversation

clewis7
Copy link
Member

@clewis7 clewis7 commented Jun 7, 2024

based on graphic features refactor

closes #510

docs/source/user_guide/guide.rst Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
Copy link
Member

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
Member Author

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

@kushalkolar
Copy link
Member

A section on the spaces would be very useful. There exists world space, data space (which is basically world space + offset and rotation), and screen space. There's a help func to map from screen space to world space that's useful for interacting with graphics.

docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
@kushalkolar
Copy link
Member

A section on using it interactively would be very useful, similar what's on wgpu docs: https://wgpu-py.readthedocs.io/en/stable/gui.html#using-wgpu-interactively

basically:

  • in jupyter
    • if nothing special is done, uses remote frame buffer, display in cell output or side
    • %gui qt before importing fastplotlib will use qt
    • Figure(canvas="glfw") should force glfw
    • Do not mix or switch between gui backends, ex. if you want to use qt use %gui qt at the start of the notebook, and then do not try to force another backend such as jupyter_rfb (remote frame buffeR)
  • in ipython
    • can use qt or glfw, same was as above

docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
docs/source/user_guide/guide.rst Outdated Show resolved Hide resolved
@@ -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
Member

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
Member Author

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

docs/source/user_guide/guide.rst Show resolved Hide resolved
clewis7 and others added 2 commits June 22, 2024 11:33
Co-authored-by: Kushal Kolar <kushalkolar@gmail.com>
@kushalkolar kushalkolar marked this pull request as ready for review June 22, 2024 16:38
Copy link
Member

@kushalkolar kushalkolar left a comment

Choose a reason for hiding this comment

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

yay

@kushalkolar
Copy link
Member

I'm going to merge but those warnings and images have to be fixed.

@kushalkolar kushalkolar merged commit d0b8bb1 into main Jun 22, 2024
14 of 15 checks passed
@kushalkolar kushalkolar deleted the guide branch July 1, 2024 20:55
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.

add "Guide" to docs
2 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.