Skip to content

Commit 3a3c9db

Browse files
kushalkolarkushalkolar
authored
docs revamp (#273)
* progress on auto generating docs * changes for docs, move selector features to features module * docs progress * fix table, remove unnecessary class attribute * add NB_SNAPSHOT env variable for docs * add new api docs * I can't spell nbsphinx * fix child_type issue for collections * move logo file * update logo path * cleanup
1 parent 5e6438e commit 3a3c9db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+3329
-595
lines changed

‎.readthedocs.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ build:
1010
- libxcb-xfixes0-dev
1111
- mesa-vulkan-drivers
1212
- libglfw3
13+
- pandoc
1314
jobs:
1415
pre_install:
1516
- pip install git+https://github.com/pygfx/pygfx.git@main

‎docs/source/_static/logo.png‎

Lines changed: 3 additions & 0 deletions
Loading

‎docs/source/_static/style.css‎

Whitespace-only changes.

‎docs/source/_templates/autosummary/class.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{{ fullname | escape | underline}}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autoclass:: {{ objname }}

‎docs/source/api/graphic_features.rst‎

Lines changed: 0 additions & 81 deletions
This file was deleted.

‎docs/source/api/graphic_features/CmapFeature.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.. _api.CmapFeature:
2+
3+
CmapFeature
4+
***********
5+
6+
===========
7+
CmapFeature
8+
===========
9+
.. currentmodule:: fastplotlib.graphics._features
10+
11+
Constructor
12+
~~~~~~~~~~~
13+
.. autosummary::
14+
:toctree: CmapFeature_api
15+
16+
CmapFeature
17+
18+
Properties
19+
~~~~~~~~~~
20+
.. autosummary::
21+
:toctree: CmapFeature_api
22+
23+
CmapFeature.buffer
24+
CmapFeature.values
25+
26+
Methods
27+
~~~~~~~
28+
.. autosummary::
29+
:toctree: CmapFeature_api
30+
31+
CmapFeature.add_event_handler
32+
CmapFeature.block_events
33+
CmapFeature.clear_event_handlers
34+
CmapFeature.remove_event_handler
35+

‎docs/source/api/graphic_features/ColorFeature.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. _api.ColorFeature:
2+
3+
ColorFeature
4+
************
5+
6+
============
7+
ColorFeature
8+
============
9+
.. currentmodule:: fastplotlib.graphics._features
10+
11+
Constructor
12+
~~~~~~~~~~~
13+
.. autosummary::
14+
:toctree: ColorFeature_api
15+
16+
ColorFeature
17+
18+
Properties
19+
~~~~~~~~~~
20+
.. autosummary::
21+
:toctree: ColorFeature_api
22+
23+
ColorFeature.buffer
24+
25+
Methods
26+
~~~~~~~
27+
.. autosummary::
28+
:toctree: ColorFeature_api
29+
30+
ColorFeature.add_event_handler
31+
ColorFeature.block_events
32+
ColorFeature.clear_event_handlers
33+
ColorFeature.remove_event_handler
34+

‎docs/source/api/graphic_features/FeatureEvent.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. _api.FeatureEvent:
2+
3+
FeatureEvent
4+
************
5+
6+
============
7+
FeatureEvent
8+
============
9+
.. currentmodule:: fastplotlib.graphics._features
10+
11+
Constructor
12+
~~~~~~~~~~~
13+
.. autosummary::
14+
:toctree: FeatureEvent_api
15+
16+
FeatureEvent
17+
18+
Properties
19+
~~~~~~~~~~
20+
.. autosummary::
21+
:toctree: FeatureEvent_api
22+
23+
24+
Methods
25+
~~~~~~~
26+
.. autosummary::
27+
:toctree: FeatureEvent_api
28+
29+

‎docs/source/api/graphic_features/GraphicFeature.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. _api.GraphicFeature:
2+
3+
GraphicFeature
4+
**************
5+
6+
==============
7+
GraphicFeature
8+
==============
9+
.. currentmodule:: fastplotlib.graphics._features
10+
11+
Constructor
12+
~~~~~~~~~~~
13+
.. autosummary::
14+
:toctree: GraphicFeature_api
15+
16+
GraphicFeature
17+
18+
Properties
19+
~~~~~~~~~~
20+
.. autosummary::
21+
:toctree: GraphicFeature_api
22+
23+
24+
Methods
25+
~~~~~~~
26+
.. autosummary::
27+
:toctree: GraphicFeature_api
28+
29+
GraphicFeature.add_event_handler
30+
GraphicFeature.block_events
31+
GraphicFeature.clear_event_handlers
32+
GraphicFeature.remove_event_handler
33+

‎docs/source/api/graphic_features/GraphicFeatureIndexable.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. _api.GraphicFeatureIndexable:
2+
3+
GraphicFeatureIndexable
4+
***********************
5+
6+
=======================
7+
GraphicFeatureIndexable
8+
=======================
9+
.. currentmodule:: fastplotlib.graphics._features
10+
11+
Constructor
12+
~~~~~~~~~~~
13+
.. autosummary::
14+
:toctree: GraphicFeatureIndexable_api
15+
16+
GraphicFeatureIndexable
17+
18+
Properties
19+
~~~~~~~~~~
20+
.. autosummary::
21+
:toctree: GraphicFeatureIndexable_api
22+
23+
GraphicFeatureIndexable.buffer
24+
25+
Methods
26+
~~~~~~~
27+
.. autosummary::
28+
:toctree: GraphicFeatureIndexable_api
29+
30+
GraphicFeatureIndexable.add_event_handler
31+
GraphicFeatureIndexable.block_events
32+
GraphicFeatureIndexable.clear_event_handlers
33+
GraphicFeatureIndexable.remove_event_handler
34+

0 commit comments

Comments
 (0)