Skip to content

Commit 22f32ac

Browse files
committed
📖 updating docs
1 parent 7517dfd commit 22f32ac

File tree

4 files changed

+24
-5
lines changed

4 files changed

+24
-5
lines changed

docs/sphinx/api_reference.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
API reference 📖
2-
================
1+
API 📖
2+
======
33

44
.. autosummary::
55
:toctree: _autosummary
@@ -9,4 +9,7 @@ API reference 📖
99
plotly_resampler.figure_resampler
1010

1111
.. _aggregation
12-
plotly_resampler.aggregation
12+
plotly_resampler.aggregation
13+
14+
.. _registering
15+
plotly_resampler.registering

docs/sphinx/dash_app_integration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77

88

99

10-
Integration with a dash app 🤝
11-
==============================
10+
Dash integration 🤝
11+
===================
1212

1313
This documentation page describes how you can integrate ``plotly-resampler`` in a `dash <https://dash.plotly.com/>`_ application.
1414

docs/sphinx/figure_resampler.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,11 @@ FigureWidgetResampler
2727
:undoc-members:
2828
:show-inheritance:
2929

30+
^^^^^^^^^^^^^^^^^
31+
utility functions
32+
^^^^^^^^^^^^^^^^^
33+
34+
.. automodule:: plotly_resampler.figure_resampler.utils
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

docs/sphinx/registering.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
2+
(un)wrapping plotly figures
3+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
4+
5+
.. automodule:: plotly_resampler.registering
6+
:members:
7+
:undoc-members:
8+
:show-inheritance:

0 commit comments

Comments
 (0)