Autogenerate the docs

Author: cbbcbail

.github/workflows/main.yml

@@ -1,12 +1,12 @@
-name: deploy-book
+name: deploy-docs
 
 on:
   push:
     branches:
     - main
 
 jobs:
-  deploy-book:
+  deploy-docs:
     runs-on: ubuntu-latest
     permissions:
       pages: write
@@ -21,23 +21,22 @@ jobs:
         python-version: 3.13
 
     - name: Install project and dependencies
-      run: pip install -e .[dev]
+      run: pip install -e .[docs]
 
     - name: Cache executed notebooks
       uses: actions/cache@v4
       with:
-        path: _build/.jupyter_cache
-        key: jupyter-book-cache-${{ hashFiles('pyproject.toml') }}
+        path: docs/_build/.jupyter_cache
+        key: jupyter-cache-${{ hashFiles('pyproject.toml') }}
+        restore-keys: jupyter-cache-
 
-    - name: Build the book
-      run: |
-        cd jupyter
-        jupyter-book build .
+    - name: Build the docs
+      run: sphinx-build -b html docs docs/_build/html
 
-    - name: Upload the book as an artifact
+    - name: Upload as a GitHub Pages artifact
       uses: actions/upload-pages-artifact@v3
       with:
-        path: "jupyter/_build/html"
+        path: "docs/_build/html"
 
     - name: Deploy to GitHub Pages
       id: deployment

docs/_static

@@ -0,0 +1,55 @@
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../src'))
+
+# -- Project information -----------------------------------------------------
+project = 'Flexible Subset Selection Examples'
+author = 'Connor Bailey'
+copyright = '2025, Connor Bailey'
+release = '0.2'
+
+# -- Extensions ----------------------------------------------------------------
+extensions = [
+    'myst_nb', 
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.autosummary',
+    'sphinx_autodoc_typehints',
+    'sphinx_copybutton',
+    'sphinx.ext.mathjax',
+    'sphinx_togglebutton',
+    'sphinx_design',
+    'autoapi.extension'
+]
+myst_enable_extensions = [
+    "dollarmath",
+    "colon_fence",
+    "amsmath",
+]
+
+# -- HTML output ---------------------------------------------------------------
+html_theme = 'sphinx_book_theme'
+html_static_path = ['_static']
+html_logo = None  
+html_title = project
+
+html_theme_options = {
+    "repository_url": "https://github.com/uwgraphics/flexibleSubsetSelection",
+    "repository_branch": "main",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
+    "path_to_docs": "docs",
+}
+
+# -- AutoAPI configuration -----------------------------------------------------
+autoapi_type = 'python'
+autoapi_dirs = ['../src/flexibleSubsetSelection']
+autosummary_generate = True
+autoapi_add_toctree_entry = False
+autoapi_root = 'api'
+
+# Paths and excludes
+templates_path = ['_templates']
+exclude_patterns = ['_build', '**.ipynb_checkpoints']
+nb_execution_mode = "off"