Add github actions doc build

.github/workflows/build_docs.yml

@@ -0,0 +1,27 @@
+name: Build docs
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .[docs]
+    - name: Build docs
+      run: |
+        cd docs
+        make html

docs/conf.py

@@ -39,7 +39,8 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
-    'sphinx_gallery.gen_gallery'
+    'sphinx_gallery.gen_gallery',
+    'jupyter_sphinx.execute'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -126,3 +127,14 @@
     'remove_config_comments': True,
     'doc_module': ('sunkit_pyvista'),
 }
+
+import pyvista
+import numpy as np
+
+# Manage errors
+pyvista.set_error_output_file("errors.txt")
+# Ensure that offscreen rendering is used for docs generation
+pyvista.OFF_SCREEN = True  # Not necessary - simply an insurance policy
+# Preferred plotting style for documentation
+pyvista.set_plot_theme("document")
+pyvista.global_theme.window_size = np.array([512, 256]) * 2

docs/index.rst

@@ -2,7 +2,25 @@
 sunkit-pyvista Documentation
 ****************************
 
-This is the documentation for sunkit-pyvista.
+.. jupyter-execute::
+   :hide-code:
+
+   # using ipyvtk as it loads faster
+   import pyvista
+   pyvista.set_jupyter_backend('ipygany')
+
+``sunkit-pyvista`` is a python package for visualising solar physics data in
+3D. As a quick example:
+
+
+.. jupyter-execute::
+
+    grid = pyvista.Sphere()
+
+    plotter = pyvista.Plotter()
+    plotter.add_mesh(grid)
+    plotter.show()
+
 
 .. toctree::
    :maxdepth: 2

setup.cfg

@@ -44,6 +44,8 @@ tests =
     pytest-cov
     pytest-doctestplus
 docs =
+    ipygany
+    jupyter-sphinx
     sphinx
     sphinx-automodapi
     sphinx-automodapi

sunkit_pyvista/plotter.py

@@ -66,7 +66,7 @@ def _coords_to_xyz(self, coords):
 
     def set_camera_coordinate(self, coord):
         """
-        Sets the inital camera position of the rendered plot.
+        Sets the camera position.
 
         Parameters
         ----------
@@ -91,7 +91,6 @@ def set_view_angle(self, angle: u.deg):
         if not view_angle > 0 and view_angle <= 180:
             raise ValueError("specified view angle must be "
                              "0 deg < angle <= 180 deg")
-        # Zoom/view_angle = current view angle (default is set to 30 degrees) / 1
         zoom_value = self.camera.view_angle / view_angle
         self.plotter.camera.zoom(zoom_value)