Port pure Sphinx site to Jupyter Book 1

.circleci/config.yml

@@ -3,22 +3,11 @@ version: 2.1
 jobs:
   build:
     docker:
-      - image: cimg/python:3.12
+      - image: cimg/python:3.13
 
     steps:
       - checkout
 
-      - run:
-          name: Install TeX
-          command: |
-            sudo apt update
-            sudo apt install -y \
-              dvipng \
-              latexmk \
-              texlive-latex-extra \
-              texlive-fonts-extra \
-              texlive-extra-utils
-
       - restore_cache:
           keys:
             - pip-cache-v1
@@ -27,7 +16,7 @@ jobs:
           name: Install Python dependencies
           command: |
             pip install --upgrade --user pip
-            pip install --user -r requirements.txt
+            pip install --user -r build_requirements.txt
             pip list
 
       - save_cache:
@@ -40,12 +29,7 @@ jobs:
           command: |
             # NOTE: bad interaction w/ blas multithreading on circleci
             export OMP_NUM_THREADS=1
-            make pdf
-            make html  # FIX: check that failing examples produce failure
-            cp \
-              ScientificPythonLectures.pdf \
-              ScientificPythonLectures-simple.pdf \
-              build/html/_downloads/
+            make web  # FIX: check that failing examples produce failure
 
       - store_artifacts:
-          path: build/html
+          path: _build/html

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = .git,*.pdf,*.svg,*.csv
+ignore-words-list = trough,remainers,befores

.github/workflows/lint.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Install packages
         run: |
           pip install --upgrade pip wheel setuptools
-          pip install -r requirements.txt
+          pip install -r build_requirements.txt
           pip list
 
       - name: Lint

.github/workflows/pages.yml

@@ -27,26 +27,23 @@ jobs:
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip wheel setuptools
-          python -m pip install -r requirements.txt
+          python -m pip install -r build_requirements.txt
+          # Resolution pushes jupyter-book down many versions.  Force upgrade.
+          python -m pip install -U jupyter-book
 
-      - name: "Build PDF & HTML"
+      - name: "Build HTML"
         run: |
-          make pdf
           make html
-          mv \
-              ScientificPythonLectures.pdf \
-              ScientificPythonLectures-simple.pdf \
-              build/html/_downloads
-          echo -n 'lectures.scientific-python.org' > build/html/CNAME
-          touch build/html/.nojekyll
+          echo -n 'lectures.scientific-python.org' > _build/html/CNAME
+          touch _build/html/.nojekyll
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v4
         with:
           deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-          external_repository: scipy-lectures/lectures.scientific-python.org
+          # external_repository: scipy-lectures/lectures.scientific-python.org
           publish_branch: gh-pages
-          publish_dir: ./build/html
+          publish_dir: ./_build/html
           force_orphan: true
           user_name: "github-actions[bot]"
           user_email: "github-actions[bot]@users.noreply.github.com"

.github/workflows/test.yml

@@ -28,9 +28,13 @@ jobs:
 
       - name: Install packages
         run: |
-          python -m pip install --upgrade pip wheel setuptools
-          python -m pip install -r requirements.txt
+          python -m pip install -r test_requirements.txt
           python -m pip list
 
-      - name: Test lectures
-        run: make test
+      - name: Test
+        run: |
+          # Avoid deprecation error.
+          export JUPYTER_PLATFORM_DIRS=1
+          jupyter --paths
+
+          make test

.gitignore

@@ -45,3 +45,17 @@ airfares.txt
 wages.txt
 ScientificPythonLectures-simple.pdf
 ScientificPythonLectures.pdf
+.ipynb_checkpoints/
+__pycache__/
+.ok_storage
+*.ipynb
+*.orig
+node_modules/
+.jupyterlite.doit.db
+advanced/advanced_numpy/test.png
+packages/scikit-image/cat.png
+advanced/advanced_numpy/test_recolored.png
+advanced/advanced_numpy/test_red.png
+intro/language/junk.txt
+intro/language/test.pkl
+joblib/

.pre-commit-config.yaml

@@ -45,6 +45,8 @@ repos:
         additional_dependencies:
           - types-aiofiles
           - types-requests
+          - types-docutils
+          - types-PyYAML
           - pandas-stubs
           - types-pillow
           - matplotlib
@@ -56,6 +58,8 @@ repos:
             | .*/setup.*\.py$
             | .*/demo.py$
             | .*/auto_examples/
+            | _scripts/examples2nb.py$
+            | _scripts/post_parser.py$
             | advanced/mathematical_optimization/examples/plot_gradient_descent\.py$
             | advanced/mathematical_optimization/examples/helper/compare_optimizers\.py$
             | advanced/advanced_numpy/examples/view-colors\.py$