Merge pull request #18 from wpreimes/ts2img

New Ts2img implementation

.github/workflows/build.yml

@@ -55,7 +55,7 @@ jobs:
       - name: Install package and test
         shell: bash -l {0}
         run: |
-          pip install .
+          pip install -e .[testing]
           pytest
       - name: Upload Coverage
         shell: bash -l {0}

.readthedocs.yml

@@ -14,4 +14,5 @@ sphinx:
   configuration: docs/conf.py
 
 conda:
-  environment: environment.yml
+  environment: docs/env.yml
+

docs/conf.py

@@ -11,6 +11,39 @@
 import sys
 import shutil
 
+
+import subprocess
+
+# Create kernel for notebooks
+on_rtd = "READTHEDOCS" in os.environ and os.environ["READTHEDOCS"]
+if on_rtd:
+    rtd_project = os.environ["READTHEDOCS_PROJECT"]
+    rtd_version = os.environ["READTHEDOCS_VERSION"]
+    interpreter = (
+        f"/home/docs/checkouts/readthedocs.org/user_builds/{rtd_project}/"
+        f"conda/{rtd_version}/bin/python"
+    )
+else:
+    interpreter = "python"
+
+print("Installing kernel")
+subprocess.run(
+    [
+        interpreter,
+        "-m",
+        "ipykernel",
+        "install",
+        "--user",
+        "--name",
+        "conda-env-repurpose-py",
+        "--display-name",
+        "Python [conda env:repurpose]"
+    ],
+    check=True,
+    capture_output=True,
+)
+print("Done")
+
 # -- Path setup --------------------------------------------------------------
 
 __location__ = os.path.dirname(__file__)
@@ -72,6 +105,7 @@
     "sphinx.ext.ifconfig",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
+    "nbsphinx",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -153,7 +187,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/env.yml

@@ -0,0 +1,16 @@
+# To keep the RTD build as small as possible, we define a separate .yml here
+name: docs
+channels:
+- conda-forge
+- defaults
+dependencies:
+- python=3.10
+- ipykernel
+- nbsphinx
+- mock
+- pillow
+- sphinx<7
+- sphinx_rtd_theme
+- pip:
+  - recommonmark
+  - readthedocs-sphinx-ext