Make docs (#30)

* 🎨 Add `build docs` in github action
arafune · Jul 23, 2024 · 1629f22 · 1629f22
1 parent a6c61a2
commit 1629f22
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
@@ -32,7 +32,7 @@ jobs:
       - name: Install libhdf5-dev by apt
         run: |
           sudo apt -y update
-          sudo apt -y install libhdf5-dev libnetcdf-dev
+          sudo apt -y install libhdf5-dev libnetcdf-dev make pandoc
 
       - name: Rye activation
         run: |
@@ -41,6 +41,12 @@ jobs:
       - name: test with rye
         run: rye run pytest -vv --color=yes --cov=./  --cov-report=xml
 
+      - name: Build docs
+        run: |
+          source .venv/bin/activate
+          cd docs
+          make html
+
       - uses: codecov/codecov-action@v4
         with:
           fail_ci_if_error: true # optional (default = false)

diff --git a/docs/source/CHANGELOG.rst b/docs/source/CHANGELOG.rst
@@ -10,7 +10,7 @@ incompatibilities between versions, while minor (-.X.-) numbers
 primarily indicate new features and documentation.
 
 4.0.1 (2024-07-21)
-
+^^^^^^^^^^^^^^^^^^
 
 Changed
 ~~~~~~~
@@ -30,7 +30,7 @@ The name change
 
 
 4.0.0 (2024-07-12)
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^
 
 New
 ~~~

diff --git a/docs/source/notebooks/custom-dot-t-functionality.ipynb b/docs/source/notebooks/custom-dot-t-functionality.ipynb
@@ -1943,9 +1943,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "py311",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
-   "name": "py311"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {

diff --git a/src/arpes/analysis/filters.py b/src/arpes/analysis/filters.py
@@ -22,6 +22,7 @@
     "boxcar_filter_arr",
     "gaussian_filter",
     "gaussian_filter_arr",
+    "savitzky_golay_filter",
 )