From eeb268d8588060ce18035e4c9714318c726cffe3 Mon Sep 17 00:00:00 2001
From: Marcelo Zoccoler <marcelozoc@gmail.com>
Date: Wed, 16 Jul 2025 15:39:18 +0200
Subject: [PATCH 1/3] Add ReadTheDocs config and update doc requirements

Introduces .readthedocs.yaml for documentation builds and adds a placeholder references.bib file. Updates docs/requirements.txt to include matplotlib, numpy, PyQt5, and qtpy for enhanced documentation capabilities.
---
 .readthedocs.yaml     | 24 ++++++++++++++++++++++++
 docs/references.bib   |  2 ++
 docs/requirements.txt |  4 ++++
 3 files changed, 30 insertions(+)
 create mode 100644 .readthedocs.yaml
 create mode 100644 docs/references.bib

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 00000000..1bbd446d
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,24 @@
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.13"
+  jobs:
+    pre_build:
+      # Generate on-the-fly Sphinx configuration from Jupyter Book's _config.yml
+      - "jupyter-book config sphinx docs/"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+
+formats:
+  - pdf
+  - epub
diff --git a/docs/references.bib b/docs/references.bib
new file mode 100644
index 00000000..a845151c
--- /dev/null
+++ b/docs/references.bib
@@ -0,0 +1,2 @@
+---
+---
diff --git a/docs/requirements.txt b/docs/requirements.txt
index f8c1727d..6906294e 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -2,3 +2,7 @@ sphinx-inline-tabs
 sphinx-proof
 sphinx-examples
 jupyter-book
+matplotlib
+numpy
+PyQt5
+qtpy

From 888a195b435fa3e5f1004ee487dc129688001deb Mon Sep 17 00:00:00 2001
From: Marcelo Zoccoler <marcelozoc@gmail.com>
Date: Wed, 16 Jul 2025 15:39:44 +0200
Subject: [PATCH 2/3] Delete previous deploy-book action

---
 .github/workflows/build_book.yml | 60 --------------------------------
 1 file changed, 60 deletions(-)
 delete mode 100644 .github/workflows/build_book.yml

diff --git a/.github/workflows/build_book.yml b/.github/workflows/build_book.yml
deleted file mode 100644
index 04d2a570..00000000
--- a/.github/workflows/build_book.yml
+++ /dev/null
@@ -1,60 +0,0 @@
-name: deploy-book
-
-# Run this when the master or main branch changes
-on:
-  push:
-    branches:
-    - master
-    - main
-    # If your git repository has the Jupyter Book within some-subfolder next to
-    # unrelated files, you can make this run only if a file within that specific
-    # folder has been modified.
-    #
-    # paths:
-    # - some-subfolder/**
-
-# This job installs dependencies, builds the book, and pushes it to `gh-pages`
-jobs:
-  deploy-book:
-    runs-on: ubuntu-latest
-    permissions:
-      pages: write
-      id-token: write
-    steps:
-    - uses: actions/checkout@v4
-
-    # Install dependencies
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.11'
-        cache: pip # Implicitly uses requirements.txt for cache key
-
-    - name: Install dependencies
-      run: pip install -r docs/requirements.txt
-
-    # (optional) Cache your executed notebooks between runs
-    # if you have config:
-    # execute:
-    #   execute_notebooks: cache
-    - name: cache executed notebooks
-      uses: actions/cache@v4
-      with:
-        path: _build/.jupyter_cache
-        key: jupyter-book-cache-${{ hashFiles('docs/requirements.txt') }}
-
-    # Build the book
-    - name: Build the book
-      run: |
-        jupyter-book build ./docs/
-
-    # Upload the book's HTML as an artifact
-    - name: Upload artifact
-      uses: actions/upload-pages-artifact@v3
-      with:
-        path: "docs/_build/html"
-
-    # Deploy the book's HTML to GitHub Pages
-    - name: Deploy to GitHub Pages
-      id: deployment
-      uses: actions/deploy-pages@v4

From 354c5aa2eb2435bf626eae55f8001aa53ca845e0 Mon Sep 17 00:00:00 2001
From: Marcelo Zoccoler <marcelozoc@gmail.com>
Date: Wed, 16 Jul 2025 15:42:15 +0200
Subject: [PATCH 3/3] remove PyQt5 from requirements to build docs

---
 docs/requirements.txt | 1 -
 1 file changed, 1 deletion(-)

diff --git a/docs/requirements.txt b/docs/requirements.txt
index 6906294e..70085fd1 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -4,5 +4,4 @@ sphinx-examples
 jupyter-book
 matplotlib
 numpy
-PyQt5
 qtpy