Merge pull request #623 from cvanelteren/add-docs-to-workflow

Add docs to workflow

Author: molinav

.github/workflows/build.yml

@@ -211,6 +211,87 @@ jobs:
           python -m twine check dist/*.tar.gz
           python -m twine check dist/*.whl
 
+  docs:
+    name: Build documentation
+    needs: [build_wheels]
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Download data packages
+        uses: actions/download-artifact@v4
+        with:
+          path: ./data_packages/
+          pattern: "dist-basemap_data*"
+          merge-multiple: true
+
+      - name: Download basemap wheel for Linux
+        uses: actions/download-artifact@v4
+        with:
+          path: ./wheels/
+          pattern: "dist-basemap-wheels-ubuntu-*"
+          merge-multiple: true
+
+      - name: Install packages
+        run: |
+          # Get Python version.
+          IMPL=cp$(python -c "import sys; print('{0}{1}'.format(*sys.version_info[:2]))")
+
+          # Install basemap wheel matching current Python version.
+          WHEEL=$(find ./wheels -name "*-${IMPL}-${IMPL}*.whl" | head -1)
+          if [ -n "${WHEEL}" ]; then
+            python -m pip install "${WHEEL}"
+          else
+            echo "No matching wheel found for ${IMPL}-${IMPL}"
+            exit 1
+          fi
+
+          # Install basemap data packages.
+          python -m pip install ./data_packages/*.whl
+
+      - name: Install docs requirements
+        run: |
+          cd packages/basemap
+          python -m pip install -r requirements-doc.txt
+
+      - name: Run sphinx
+        run: |
+          cd packages/basemap
+          python -m sphinx doc/source public
+
+      - name: Upload docs artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: packages/basemap/public
+
+      - name: Upload github-pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          name: github-pages
+          path: packages/basemap/public
+
+  pages:
+    name: Deploy documentation
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    needs: [docs, check]
+    runs-on: ubuntu-22.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - name: Deploy github-pages
+        uses: actions/deploy-pages@v3
+        id: deployment
+
   upload:
     name: Upload packages
     needs: [build_data, build_sdist, build_wheels, check]

CHANGELOG.md

@@ -15,15 +15,16 @@ https://semver.org/spec/v2.0.0.html
 ### Added
 - Python 3.13 support (PR [#619], solves issue [#608]).
 - NumPy 2.0 support (PR [#614] by @cvanelteren, solves issue [#604]).
-- Automated wheels for x86_64 and arm64 (PRs [#620] and [#622] by
-  @cvanelteren, solves issue [#608]).
+- Automated wheels for x86_64 and arm64 (PR [#620] by @cvanelteren,
+  solves issue [#608]).
 
 ### Changed
 - **BREAKING CHANGE**: Set Python minimum supported version to 3.9.
 - **BREAKING CHANGE**: Migrate `basemap` libraries to use implicit
   namespace packages (PR [#576] by @ksunden).
-- Migrate workflows to use `cibuildwheel` (PRs [#614] and [#618] by
-  @cvanelteren and PR [#621], solves GitHub artifact actions v1 sunset).
+- Migrate workflows to use `cibuildwheel` (PRs [#614], [#618], [#622]
+  and [#623] by @cvanelteren and PR [#621], solves GitHub artifact
+  actions v1 sunset).
 - Update library dependencies:
   - Upgrade upper limit for `basemap_data` to 3.0.
   - Upgrade lower limit for `packaging` to 20.5.
@@ -1156,6 +1157,8 @@ https://semver.org/spec/v2.0.0.html
 - Fix glitches in drawing of parallels and meridians.
 
 
+[#623]:
+https://github.com/matplotlib/basemap/pull/623
 [#622]:
 https://github.com/matplotlib/basemap/pull/622
 [#621]: