CI: Build documentation using pixi (#65075)

Author: mroeschke

.github/workflows/code-checks.yml

@@ -53,18 +53,10 @@ jobs:
       run: cd ci && ./code_checks.sh doctests
       if: ${{ steps.build.outcome == 'success' && always() }}
 
-    - name: Check for no warnings when building single-page docs
-      run: ci/code_checks.sh single-docs
-      if: ${{ steps.build.outcome == 'success' && always() }}
-
     - name: Run checks on imported code
       run: ci/code_checks.sh code
       if: ${{ steps.build.outcome == 'success' && always() }}
 
-    - name: Run check of documentation notebooks
-      run: ci/code_checks.sh notebooks
-      if: ${{ steps.build.outcome == 'success' && always() }}
-
     - name: Use existing environment for type checking
       run: |
         echo $PATH >> $GITHUB_PATH

.github/workflows/docbuild-and-upload.yml

@@ -22,8 +22,9 @@ on:
         type: boolean
         default: false
 
-env:
-  ENV_FILE: environment.yml
+defaults:
+  run:
+    shell: bash -euox pipefail {0}
 
 permissions: {}
 
@@ -39,10 +40,6 @@ jobs:
       group: ${{ github.event_name == 'push' && github.run_number || github.ref }}-web-docs
       cancel-in-progress: true
 
-    defaults:
-      run:
-        shell: bash -el {0}
-
     steps:
     - name: Set pandas version
       env:
@@ -83,33 +80,68 @@ jobs:
       with:
         fetch-depth: 0
 
-    - name: Set up Conda
-      uses: ./.github/actions/setup-conda
-
-    - name: Build Pandas
-      uses: ./.github/actions/build_pandas
+    - name: Create virtual environment with Pixi
+      uses: ./.github/actions/setup-pixi
+      with:
+        environment: docs-and-web
 
-    - name: Extra installs
-      # https://pytest-qt.readthedocs.io/en/latest/troubleshooting.html#github-actions-azure-pipelines-travis-ci-and-gitlab-ci-cd
-      run: sudo apt-get update && sudo apt-get install -y libegl1 libopengl0
+    - name: Build pandas
+      run: |
+        pixi run \
+          --environment docs-and-web \
+          build-pandas \
+          --editable \
+          -Csetup-args="--werror"
 
     - name: Test website
-      run: python -m pytest web/
+      run: |
+        pixi run \
+          --environment docs-and-web \
+          ci-test-website
+
+    - name: Test build single page doc
+      run: |
+        pixi run \
+          --environment docs-and-web \
+          ci-test-single-page-doc pandas.Series.value_counts
+        pixi run \
+          --environment docs-and-web \
+          ci-test-single-page-doc pandas.Series.str.split
+
+    - name: Test nbconvert doc notebooks
+      run: |
+        pixi run \
+          --environment docs-and-web \
+          ci-test-nbconvert-doc-notebooks "$(find doc/source -name '*.ipynb')"
 
     - name: Build website
-      run: python web/pandas_web.py web/pandas --target-path=web/build
+      run: |
+        pixi run \
+          --environment docs-and-web \
+          ci-build-website
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Build documentation
-      run: doc/make.py --warnings-are-errors
+      run: |
+        pixi run \
+          --environment docs-and-web \
+          ci-build-documentation \
+          html
 
     - name: Build the interactive terminal
       working-directory: web/interactive_terminal
-      run: jupyter lite build
+      run: |
+        pixi run \
+          --environment docs-and-web \
+          ci-build-interactive_terminal
 
     - name: Build documentation zip
-      run: doc/make.py zip_html
+      run: |
+        pixi run \
+          --environment docs-and-web \
+          ci-build-documentation \
+          zip_html
 
     - name: Install ssh key
       run: |

ci/code_checks.sh

@@ -9,8 +9,6 @@
 #   $ ./ci/code_checks.sh               # run all checks
 #   $ ./ci/code_checks.sh code          # checks on imported code
 #   $ ./ci/code_checks.sh doctests      # run doctests
-#   $ ./ci/code_checks.sh single-docs   # check single-page docs build warning-free
-#   $ ./ci/code_checks.sh notebooks     # check execution of documentation notebooks
 
 set -uo pipefail
 
@@ -21,8 +19,8 @@ else
     CHECK=""
 fi
 
-[[ -z "$CHECK" || "$CHECK" == "code" || "$CHECK" == "doctests" || "$CHECK" == "single-docs" || "$CHECK" == "notebooks" ]] || \
-    { echo "Unknown command $1. Usage: $0 [code|doctests|single-docs|notebooks]"; exit 1; }
+[[ -z "$CHECK" || "$CHECK" == "code" || "$CHECK" == "doctests" ]] || \
+    { echo "Unknown command $1. Usage: $0 [code|doctests]"; exit 1; }
 
 RET=0
 
@@ -60,19 +58,4 @@ if [[ -z "$CHECK" || "$CHECK" == "doctests" ]]; then
 
 fi
 
-### DOCUMENTATION NOTEBOOKS ###
-if [[ -z "$CHECK" || "$CHECK" == "notebooks" ]]; then
-
-    MSG='Notebooks' ; echo $MSG
-    jupyter nbconvert --execute "$(find doc/source -name '*.ipynb')" --to notebook
-    RET=$(($RET + $?)) ; echo $MSG "DONE"
-
-fi
-
-### SINGLE-PAGE DOCS ###
-if [[ -z "$CHECK" || "$CHECK" == "single-docs" ]]; then
-    python doc/make.py --warnings-are-errors --no-browser --single pandas.Series.value_counts
-    python doc/make.py --warnings-are-errors --no-browser --single pandas.Series.str.split
-fi
-
 exit $RET

doc/source/conf.py

@@ -761,11 +761,9 @@ def _pandas_validate(obj_name, validator_cls=None, **validator_kwargs):
 
 if include_api:
     intersphinx_mapping = {
-        "dateutil": ("https://dateutil.readthedocs.io/en/latest/", None),
         "matplotlib": ("https://matplotlib.org/stable/", None),
         "numpy": ("https://numpy.org/doc/stable/", None),
         "python": ("https://docs.python.org/3/", None),
-        "scipy": ("https://docs.scipy.org/doc/scipy/", None),
         "pyarrow": ("https://arrow.apache.org/docs/", None),
     }