Skip to content

docs revamp #273

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 11 commits into from
Jul 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ build:
- libxcb-xfixes0-dev
- mesa-vulkan-drivers
- libglfw3
- pandoc
jobs:
pre_install:
- pip install git+https://github.com/pygfx/pygfx.git@main
Expand Down
3 changes: 3 additions & 0 deletions docs/source/_static/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file added docs/source/_static/style.css
Empty file.
5 changes: 5 additions & 0 deletions docs/source/_templates/autosummary/class.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{{ fullname | escape | underline}}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
81 changes: 0 additions & 81 deletions docs/source/api/graphic_features.rst

This file was deleted.

35 changes: 35 additions & 0 deletions docs/source/api/graphic_features/CmapFeature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. _api.CmapFeature:

CmapFeature
***********

===========
CmapFeature
===========
.. currentmodule:: fastplotlib.graphics._features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: CmapFeature_api

CmapFeature

Properties
~~~~~~~~~~
.. autosummary::
:toctree: CmapFeature_api

CmapFeature.buffer
CmapFeature.values

Methods
~~~~~~~
.. autosummary::
:toctree: CmapFeature_api

CmapFeature.add_event_handler
CmapFeature.block_events
CmapFeature.clear_event_handlers
CmapFeature.remove_event_handler

34 changes: 34 additions & 0 deletions docs/source/api/graphic_features/ColorFeature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _api.ColorFeature:

ColorFeature
************

============
ColorFeature
============
.. currentmodule:: fastplotlib.graphics._features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: ColorFeature_api

ColorFeature

Properties
~~~~~~~~~~
.. autosummary::
:toctree: ColorFeature_api

ColorFeature.buffer

Methods
~~~~~~~
.. autosummary::
:toctree: ColorFeature_api

ColorFeature.add_event_handler
ColorFeature.block_events
ColorFeature.clear_event_handlers
ColorFeature.remove_event_handler

29 changes: 29 additions & 0 deletions docs/source/api/graphic_features/FeatureEvent.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. _api.FeatureEvent:

FeatureEvent
************

============
FeatureEvent
============
.. currentmodule:: fastplotlib.graphics._features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: FeatureEvent_api

FeatureEvent

Properties
~~~~~~~~~~
.. autosummary::
:toctree: FeatureEvent_api


Methods
~~~~~~~
.. autosummary::
:toctree: FeatureEvent_api


33 changes: 33 additions & 0 deletions docs/source/api/graphic_features/GraphicFeature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. _api.GraphicFeature:

GraphicFeature
**************

==============
GraphicFeature
==============
.. currentmodule:: fastplotlib.graphics._features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: GraphicFeature_api

GraphicFeature

Properties
~~~~~~~~~~
.. autosummary::
:toctree: GraphicFeature_api


Methods
~~~~~~~
.. autosummary::
:toctree: GraphicFeature_api

GraphicFeature.add_event_handler
GraphicFeature.block_events
GraphicFeature.clear_event_handlers
GraphicFeature.remove_event_handler

34 changes: 34 additions & 0 deletions docs/source/api/graphic_features/GraphicFeatureIndexable.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _api.GraphicFeatureIndexable:

GraphicFeatureIndexable
***********************

=======================
GraphicFeatureIndexable
=======================
.. currentmodule:: fastplotlib.graphics._features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: GraphicFeatureIndexable_api

GraphicFeatureIndexable

Properties
~~~~~~~~~~
.. autosummary::
:toctree: GraphicFeatureIndexable_api

GraphicFeatureIndexable.buffer

Methods
~~~~~~~
.. autosummary::
:toctree: GraphicFeatureIndexable_api

GraphicFeatureIndexable.add_event_handler
GraphicFeatureIndexable.block_events
GraphicFeatureIndexable.clear_event_handlers
GraphicFeatureIndexable.remove_event_handler

35 changes: 35 additions & 0 deletions docs/source/api/graphic_features/HeatmapCmapFeature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. _api.HeatmapCmapFeature:

HeatmapCmapFeature
******************

==================
HeatmapCmapFeature
==================
.. currentmodule:: fastplotlib.graphics._features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: HeatmapCmapFeature_api

HeatmapCmapFeature

Properties
~~~~~~~~~~
.. autosummary::
:toctree: HeatmapCmapFeature_api

HeatmapCmapFeature.vmax
HeatmapCmapFeature.vmin

Methods
~~~~~~~
.. autosummary::
:toctree: HeatmapCmapFeature_api

HeatmapCmapFeature.add_event_handler
HeatmapCmapFeature.block_events
HeatmapCmapFeature.clear_event_handlers
HeatmapCmapFeature.remove_event_handler

35 changes: 35 additions & 0 deletions docs/source/api/graphic_features/HeatmapDataFeature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. _api.HeatmapDataFeature:

HeatmapDataFeature
******************

==================
HeatmapDataFeature
==================
.. currentmodule:: fastplotlib.graphics._features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: HeatmapDataFeature_api

HeatmapDataFeature

Properties
~~~~~~~~~~
.. autosummary::
:toctree: HeatmapDataFeature_api

HeatmapDataFeature.buffer

Methods
~~~~~~~
.. autosummary::
:toctree: HeatmapDataFeature_api

HeatmapDataFeature.add_event_handler
HeatmapDataFeature.block_events
HeatmapDataFeature.clear_event_handlers
HeatmapDataFeature.remove_event_handler
HeatmapDataFeature.update_gpu

35 changes: 35 additions & 0 deletions docs/source/api/graphic_features/ImageCmapFeature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. _api.ImageCmapFeature:

ImageCmapFeature
****************

================
ImageCmapFeature
================
.. currentmodule:: fastplotlib.graphics._features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: ImageCmapFeature_api

ImageCmapFeature

Properties
~~~~~~~~~~
.. autosummary::
:toctree: ImageCmapFeature_api

ImageCmapFeature.vmax
ImageCmapFeature.vmin

Methods
~~~~~~~
.. autosummary::
:toctree: ImageCmapFeature_api

ImageCmapFeature.add_event_handler
ImageCmapFeature.block_events
ImageCmapFeature.clear_event_handlers
ImageCmapFeature.remove_event_handler

Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy