Add a line plot example and tutorial working (#18)

unital · Oct 23, 2024 · 04330de · 04330de
1 parent 7e877f4
commit 04330de
Show file tree

Hide file tree

Showing 24 changed files with 871 additions and 35 deletions.
diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml
@@ -16,7 +16,7 @@ jobs:
       with:
         python-version: '3.11'
     - name: Install dependencies and local packages
-      run: python -m pip install sphinx pydata-sphinx-theme sphinx-autoapi
+      run: python -m pip install sphinx pydata-sphinx-theme sphinx-autoapi sphinx-design
     - name: Build HTML documentation with Sphinx
       run: |
         make html

diff --git a/.github/workflows/check_docs.yaml b/.github/workflows/check_docs.yaml
@@ -14,7 +14,7 @@ jobs:
       with:
         python-version: '3.11'
     - name: Install dependencies and local packages
-      run: python -m pip install sphinx pydata-sphinx-theme sphinx-autoapi
+      run: python -m pip install sphinx pydata-sphinx-theme sphinx-autoapi sphinx-design
     - name: Build HTML documentation with Sphinx
       run: |
         make html

diff --git a/ci/deploy_to_device.py b/ci/deploy_to_device.py
@@ -14,6 +14,7 @@ def deploy():
     try:
         deploy_py_files(Path("examples"), ":", clear=False)
         deploy_py_files(Path("examples/devices"), ":/devices")
+        deploy_py_files(Path("examples/data"), ":/data")
         deploy_py_files(Path("src/tempe"), ":/lib/tempe")
         #deploy_py_files(Path("src/tempe/fonts"), ":/lib/tempe/fonts")
         #deploy_py_files(Path("src/tempe/colormaps"), ":/lib/tempe/colormaps")
@@ -31,7 +32,7 @@ def deploy_py_files(path: Path, destination, clear=True):
             print('remove', destination, '...')
             for file in listdir(destination):
                 file = file.decode('utf-8')
-                if not (file.endswith('.py') or file.endswith('.mpy')):
+                if not (file.endswith('.py') or file.endswith('.mpy') or file.endswith('.af')):
                     continue
                 print('remove', f"{destination}/{file}")
                 try:
@@ -47,6 +48,9 @@ def deploy_py_files(path: Path, destination, clear=True):
     for file in path.glob("*.mpy"):
         mpremote("cp", str(file), f"{destination}/{file.name}")
 
+    for file in path.glob("*.af"):
+        mpremote("cp", str(file), f"{destination}/{file.name}")
+
 
 def listdir(directory):
     listing = mpremote("ls", directory)

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -18,7 +18,8 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinx.ext.napoleon',
-    'autoapi.extension'
+    'autoapi.extension',
+    "sphinx_design",
 ]
 
 templates_path = ['_templates']

diff --git a/docs/source/user_guide/line_plot_1.png b/docs/source/user_guide/line_plot_1.png
diff --git a/docs/source/user_guide/line_plot_2.png b/docs/source/user_guide/line_plot_2.png
diff --git a/docs/source/user_guide/line_plot_3.png b/docs/source/user_guide/line_plot_3.png
diff --git a/docs/source/user_guide/line_plot_4.png b/docs/source/user_guide/line_plot_4.png
diff --git a/docs/source/user_guide/line_plot_axes.png b/docs/source/user_guide/line_plot_axes.png
diff --git a/docs/source/user_guide/line_plot_bg.png b/docs/source/user_guide/line_plot_bg.png
diff --git a/docs/source/user_guide/line_plot_border.png b/docs/source/user_guide/line_plot_border.png
diff --git a/docs/source/user_guide/lines.png b/docs/source/user_guide/lines.png