Attempt to fix docs

Author: kacpnowak

.github/workflows/pages.yml

@@ -7,18 +7,27 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      
       - uses: actions/setup-python@v3
+        with:
+          python-version: '3.10' 
+
       - name: Install dependencies
         run: |
+          pip install --upgrade pip
           pip install sphinx sphinx_rtd_theme
+          pip install -e . 
+      
       - name: Sphinx build
         run: |
-          sphinx-build docs _build
+          cd docs
+          make html
+
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
         with:
           publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: _build/
-          force_orphan: true
+          publish_dir: docs/_build/html
+          force_orphan: true

docs/conf.py

@@ -9,38 +9,39 @@
 import sys
 import os
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
-project = 'Implicit Filter'
-copyright = '2025, Kacper Nowak'
-author = 'Kacper Nowak'
+project = "Implicit Filter"
+copyright = "2025, Kacper Nowak"
+author = "Kacper Nowak"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
+autodoc_mock_imports = ["numpy", "scipy", "xarray", "jax", "cupy", "matplotlib"]
+
 extensions = [
-    'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.githubpages',
-    'sphinx_rtd_theme',
-    'sphinx.ext.napoleon'
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.githubpages",
+    "sphinx_rtd_theme",
+    "sphinx.ext.napoleon",
 ]
 
-source_suffix = '.rst'
-master_doc = 'index'
-language = 'en'
-pygments_style = 'sphinx'
-
-apidoc_module_dir = './src/implicit_filter'
-apidoc_output_dir = './_build/'
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+source_suffix = ".rst"
+master_doc = "index"
+language = "en"
+pygments_style = "sphinx"
 
+apidoc_module_dir = "./src/implicit_filter"
+apidoc_output_dir = "./_build/"
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]