Merge pull request #42 from andgoldschmidt/fix_docs

Sphinx docs update

.github/workflows/pull-docs.yml

@@ -14,7 +14,7 @@ jobs:
       # Checkout, set up python
       # ======
       - name: Check out
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
@@ -24,7 +24,7 @@ jobs:
       # ======
       - name: Load cached Poetry installation
         id: cached-poetry
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.local  # the path depends on the OS
           key: poetry-${{ matrix.poetry-version }}
@@ -34,7 +34,7 @@ jobs:
       # ======
       - name: Load cached venv
         id: cached-poetry-dependencies-docs
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: .venv
           key: docs-${{ matrix.python-version }}-${{ matrix.poetry-version }}-${{ hashFiles('**/poetry.lock') }}

.github/workflows/push-test.yml

@@ -17,7 +17,7 @@ jobs:
       # Checkout, set up python
       # ======
       - name: Check out
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
@@ -27,7 +27,7 @@ jobs:
       # ======
       - name: Load cached Poetry installation
         id: cached-poetry
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.local  # the path depends on the OS
           key: poetry-${{ matrix.poetry-version }}
@@ -44,7 +44,7 @@ jobs:
       # ======
       - name: Load cached venv
         id: cached-poetry-dependencies-dev
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: .venv
           key: dev-${{ matrix.python-version }}-${{ matrix.poetry-version }}-${{ hashFiles('**/poetry.lock') }}

.github/workflows/release.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   release:
-    name: Deploy release to Test-PyPI
+    name: Deploy release to PyPI
     runs-on: ubuntu-latest
     environment:
 #      name: testpypi
@@ -21,7 +21,7 @@ jobs:
       # Checkout, set up python
       # ======
       - name: Checkout source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.7"
+    python: "3.9"
   jobs:
     post_create_environment:
       - pip install poetry==1.2.1

docs/conf.py

@@ -52,9 +52,9 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'classic'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path = []

docs/notebooks/Examples.ipynb

@@ -333,13 +333,13 @@
    },
    "outputs": [],
    "source": [
-    "tvd =  derivative.TrendFiltered(alpha=1e-3, order=0, max_iter=1e6)\n",
+    "tvd =  derivative.TrendFiltered(alpha=1e-3, order=0, max_iter=int(1e6))\n",
     "plot_example(tvd, t, noisy_sin, np.cos, sigmas, 'order: 0')\n",
     "\n",
-    "tvd =  derivative.TrendFiltered(alpha=1e-3, order=1, max_iter=1e6)\n",
+    "tvd =  derivative.TrendFiltered(alpha=1e-3, order=1, max_iter=int(1e6))\n",
     "plot_example(tvd, t, noisy_sin, np.cos, sigmas, 'order: 1')\n",
     "\n",
-    "tvd =  derivative.TrendFiltered(alpha=1e-3, order=2, max_iter=1e6)\n",
+    "tvd =  derivative.TrendFiltered(alpha=1e-3, order=2, max_iter=int(1e6))\n",
     "plot_example(tvd, t, noisy_sin, np.cos, sigmas, 'order: 2')"
    ]
   },
@@ -521,7 +521,7 @@
    },
    "outputs": [],
    "source": [
-    "tvd =  derivative.TrendFiltered(alpha=1e-3, order=0, max_iter=1e5)\n",
+    "tvd =  derivative.TrendFiltered(alpha=1e-3, order=0, max_iter=int(1e5))\n",
     "plot_example(tvd, t, noisy_abs, d_abs, sigmas, 'order: 0')"
    ]
   },