Skip to content

using sphinx gallery to add examples to docs automatically #279

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

Closed
wants to merge 5 commits into from
Closed

using sphinx gallery to add examples to docs automatically #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2938afe
using sphinx gallery to add examples automatically
clewis7 Jul 6, 2023
273a89e
delete gallery files as irrelevant, fix title issue in gp example
clewis7 Jul 6, 2023
8364d5b
doc updates
clewis7 Jul 6, 2023
eb401dc
update gitignore to not track _gallery
clewis7 Jul 7, 2023
8992a9a
start working on custom gallery scraper
clewis7 Jul 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ instance/

# Sphinx documentation
docs/_build/
docs/source/_gallery

# PyBuilder
target/
Expand Down
6 changes: 6 additions & 0 deletions ...mapFeature_api/fastplotlib.graphics._features.CmapFeature.add_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
add\_event\_handler
===================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: CmapFeature.add_event_handler
6 changes: 6 additions & 0 deletions ...res/CmapFeature_api/fastplotlib.graphics._features.CmapFeature.block_events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
block\_events
=============

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: CmapFeature.block_events
6 changes: 6 additions & 0 deletions ..._features/CmapFeature_api/fastplotlib.graphics._features.CmapFeature.buffer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
buffer
======

.. currentmodule:: fastplotlib.graphics._features

.. autoproperty:: CmapFeature.buffer
6 changes: 6 additions & 0 deletions ...Feature_api/fastplotlib.graphics._features.CmapFeature.clear_event_handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clear\_event\_handlers
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: CmapFeature.clear_event_handlers
6 changes: 6 additions & 0 deletions ...Feature_api/fastplotlib.graphics._features.CmapFeature.remove_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
remove\_event\_handler
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: CmapFeature.remove_event_handler
6 changes: 6 additions & 0 deletions ...graphic_features/CmapFeature_api/fastplotlib.graphics._features.CmapFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
fastplotlib.graphics.\_features.CmapFeature
===========================================

.. currentmodule:: fastplotlib.graphics._features

.. autoclass:: CmapFeature
6 changes: 6 additions & 0 deletions ..._features/CmapFeature_api/fastplotlib.graphics._features.CmapFeature.values.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
values
======

.. currentmodule:: fastplotlib.graphics._features

.. autoproperty:: CmapFeature.values
6 changes: 6 additions & 0 deletions ...orFeature_api/fastplotlib.graphics._features.ColorFeature.add_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
add\_event\_handler
===================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: ColorFeature.add_event_handler
6 changes: 6 additions & 0 deletions ...s/ColorFeature_api/fastplotlib.graphics._features.ColorFeature.block_events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
block\_events
=============

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: ColorFeature.block_events
6 changes: 6 additions & 0 deletions ...eatures/ColorFeature_api/fastplotlib.graphics._features.ColorFeature.buffer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
buffer
======

.. currentmodule:: fastplotlib.graphics._features

.. autoproperty:: ColorFeature.buffer
6 changes: 6 additions & 0 deletions ...eature_api/fastplotlib.graphics._features.ColorFeature.clear_event_handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clear\_event\_handlers
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: ColorFeature.clear_event_handlers
6 changes: 6 additions & 0 deletions ...eature_api/fastplotlib.graphics._features.ColorFeature.remove_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
remove\_event\_handler
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: ColorFeature.remove_event_handler
6 changes: 6 additions & 0 deletions ...aphic_features/ColorFeature_api/fastplotlib.graphics._features.ColorFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
fastplotlib.graphics.\_features.ColorFeature
============================================

.. currentmodule:: fastplotlib.graphics._features

.. autoclass:: ColorFeature
6 changes: 6 additions & 0 deletions ...aphic_features/FeatureEvent_api/fastplotlib.graphics._features.FeatureEvent.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
fastplotlib.graphics.\_features.FeatureEvent
============================================

.. currentmodule:: fastplotlib.graphics._features

.. autoclass:: FeatureEvent
6 changes: 6 additions & 0 deletions ...pi/fastplotlib.graphics._features.GraphicFeatureIndexable.add_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
add\_event\_handler
===================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: GraphicFeatureIndexable.add_event_handler
6 changes: 6 additions & 0 deletions ...ble_api/fastplotlib.graphics._features.GraphicFeatureIndexable.block_events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
block\_events
=============

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: GraphicFeatureIndexable.block_events
6 changes: 6 additions & 0 deletions ...Indexable_api/fastplotlib.graphics._features.GraphicFeatureIndexable.buffer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
buffer
======

.. currentmodule:: fastplotlib.graphics._features

.. autoproperty:: GraphicFeatureIndexable.buffer
6 changes: 6 additions & 0 deletions ...fastplotlib.graphics._features.GraphicFeatureIndexable.clear_event_handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clear\_event\_handlers
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: GraphicFeatureIndexable.clear_event_handlers
6 changes: 6 additions & 0 deletions ...fastplotlib.graphics._features.GraphicFeatureIndexable.remove_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
remove\_event\_handler
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: GraphicFeatureIndexable.remove_event_handler
6 changes: 6 additions & 0 deletions ...FeatureIndexable_api/fastplotlib.graphics._features.GraphicFeatureIndexable.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
fastplotlib.graphics.\_features.GraphicFeatureIndexable
=======================================================

.. currentmodule:: fastplotlib.graphics._features

.. autoclass:: GraphicFeatureIndexable
6 changes: 6 additions & 0 deletions ...Feature_api/fastplotlib.graphics._features.GraphicFeature.add_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
add\_event\_handler
===================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: GraphicFeature.add_event_handler
6 changes: 6 additions & 0 deletions ...aphicFeature_api/fastplotlib.graphics._features.GraphicFeature.block_events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
block\_events
=============

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: GraphicFeature.block_events
6 changes: 6 additions & 0 deletions ...ture_api/fastplotlib.graphics._features.GraphicFeature.clear_event_handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clear\_event\_handlers
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: GraphicFeature.clear_event_handlers
6 changes: 6 additions & 0 deletions ...ture_api/fastplotlib.graphics._features.GraphicFeature.remove_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
remove\_event\_handler
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: GraphicFeature.remove_event_handler
6 changes: 6 additions & 0 deletions ...c_features/GraphicFeature_api/fastplotlib.graphics._features.GraphicFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
fastplotlib.graphics.\_features.GraphicFeature
==============================================

.. currentmodule:: fastplotlib.graphics._features

.. autoclass:: GraphicFeature
1 change: 1 addition & 0 deletions docs/source/api/graphic_features/HeatmapCmapFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ Methods
HeatmapCmapFeature.block_events
HeatmapCmapFeature.clear_event_handlers
HeatmapCmapFeature.remove_event_handler
HeatmapCmapFeature.reset_vmin_vmax

6 changes: 6 additions & 0 deletions ...ure_api/fastplotlib.graphics._features.HeatmapCmapFeature.add_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
add\_event\_handler
===================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: HeatmapCmapFeature.add_event_handler
6 changes: 6 additions & 0 deletions ...pFeature_api/fastplotlib.graphics._features.HeatmapCmapFeature.block_events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
block\_events
=============

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: HeatmapCmapFeature.block_events
6 changes: 6 additions & 0 deletions ..._api/fastplotlib.graphics._features.HeatmapCmapFeature.clear_event_handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clear\_event\_handlers
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: HeatmapCmapFeature.clear_event_handlers
6 changes: 6 additions & 0 deletions ..._api/fastplotlib.graphics._features.HeatmapCmapFeature.remove_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
remove\_event\_handler
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: HeatmapCmapFeature.remove_event_handler
6 changes: 6 additions & 0 deletions ...ature_api/fastplotlib.graphics._features.HeatmapCmapFeature.reset_vmin_vmax.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
reset\_vmin\_vmax
=================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: HeatmapCmapFeature.reset_vmin_vmax
6 changes: 6 additions & 0 deletions ...es/HeatmapCmapFeature_api/fastplotlib.graphics._features.HeatmapCmapFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
fastplotlib.graphics.\_features.HeatmapCmapFeature
==================================================

.. currentmodule:: fastplotlib.graphics._features

.. autoclass:: HeatmapCmapFeature
6 changes: 6 additions & 0 deletions ...atmapCmapFeature_api/fastplotlib.graphics._features.HeatmapCmapFeature.vmax.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
vmax
====

.. currentmodule:: fastplotlib.graphics._features

.. autoproperty:: HeatmapCmapFeature.vmax
6 changes: 6 additions & 0 deletions ...atmapCmapFeature_api/fastplotlib.graphics._features.HeatmapCmapFeature.vmin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
vmin
====

.. currentmodule:: fastplotlib.graphics._features

.. autoproperty:: HeatmapCmapFeature.vmin
6 changes: 6 additions & 0 deletions ...ure_api/fastplotlib.graphics._features.HeatmapDataFeature.add_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
add\_event\_handler
===================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: HeatmapDataFeature.add_event_handler
6 changes: 6 additions & 0 deletions ...aFeature_api/fastplotlib.graphics._features.HeatmapDataFeature.block_events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
block\_events
=============

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: HeatmapDataFeature.block_events
6 changes: 6 additions & 0 deletions ...mapDataFeature_api/fastplotlib.graphics._features.HeatmapDataFeature.buffer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
buffer
======

.. currentmodule:: fastplotlib.graphics._features

.. autoproperty:: HeatmapDataFeature.buffer
6 changes: 6 additions & 0 deletions ..._api/fastplotlib.graphics._features.HeatmapDataFeature.clear_event_handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clear\_event\_handlers
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: HeatmapDataFeature.clear_event_handlers
6 changes: 6 additions & 0 deletions ..._api/fastplotlib.graphics._features.HeatmapDataFeature.remove_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
remove\_event\_handler
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: HeatmapDataFeature.remove_event_handler
6 changes: 6 additions & 0 deletions ...es/HeatmapDataFeature_api/fastplotlib.graphics._features.HeatmapDataFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
fastplotlib.graphics.\_features.HeatmapDataFeature
==================================================

.. currentmodule:: fastplotlib.graphics._features

.. autoclass:: HeatmapDataFeature
6 changes: 6 additions & 0 deletions ...ataFeature_api/fastplotlib.graphics._features.HeatmapDataFeature.update_gpu.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
update\_gpu
===========

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: HeatmapDataFeature.update_gpu
1 change: 1 addition & 0 deletions docs/source/api/graphic_features/ImageCmapFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ Methods
ImageCmapFeature.block_events
ImageCmapFeature.clear_event_handlers
ImageCmapFeature.remove_event_handler
ImageCmapFeature.reset_vmin_vmax

6 changes: 6 additions & 0 deletions ...ature_api/fastplotlib.graphics._features.ImageCmapFeature.add_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
add\_event\_handler
===================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: ImageCmapFeature.add_event_handler
6 changes: 6 additions & 0 deletions ...mapFeature_api/fastplotlib.graphics._features.ImageCmapFeature.block_events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
block\_events
=============

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: ImageCmapFeature.block_events
6 changes: 6 additions & 0 deletions ...re_api/fastplotlib.graphics._features.ImageCmapFeature.clear_event_handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clear\_event\_handlers
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: ImageCmapFeature.clear_event_handlers
6 changes: 6 additions & 0 deletions ...re_api/fastplotlib.graphics._features.ImageCmapFeature.remove_event_handler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
remove\_event\_handler
======================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: ImageCmapFeature.remove_event_handler
6 changes: 6 additions & 0 deletions ...Feature_api/fastplotlib.graphics._features.ImageCmapFeature.reset_vmin_vmax.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
reset\_vmin\_vmax
=================

.. currentmodule:: fastplotlib.graphics._features

.. automethod:: ImageCmapFeature.reset_vmin_vmax
6 changes: 6 additions & 0 deletions ...atures/ImageCmapFeature_api/fastplotlib.graphics._features.ImageCmapFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
fastplotlib.graphics.\_features.ImageCmapFeature
================================================

.. currentmodule:: fastplotlib.graphics._features

.. autoclass:: ImageCmapFeature
6 changes: 6 additions & 0 deletions ...s/ImageCmapFeature_api/fastplotlib.graphics._features.ImageCmapFeature.vmax.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
vmax
====

.. currentmodule:: fastplotlib.graphics._features

.. autoproperty:: ImageCmapFeature.vmax
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