Merge pull request #210 from ipums/action_docs

Add github workflow to build and publish sphinx docs to github pages

Author: joegrover

.github/workflows/sphinx.yml

@@ -0,0 +1,49 @@
+name: Publish Sphinx Docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install package
+        run: uv sync --extra docs
+      - name: Build docs
+        run: cd "$GITHUB_WORKSPACE/sphinx-docs" && uv run sphinx-build . _build/
+      - name: Upload
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: sphinx-docs/_build/
+
+  deploy:
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

pyproject.toml

@@ -48,13 +48,9 @@ dev = [
     "sphinx==8.1.3",
     "recommonmark==0.7.1",
 ]
-lightgbm = [
-    "synapseml>=1.0"
-]
-xgboost = [
-    "xgboost>=2.0",
-    "pyarrow>=4.0",
-]
+docs = ["sphinx", "recommonmark"]
+lightgbm = ["synapseml>=1.0"]
+xgboost = ["xgboost>=2.0", "pyarrow>=4.0"]
 
 [project.scripts]
 hlink = "hlink.scripts.main:cli"

sphinx-docs/conf.py

@@ -32,10 +32,13 @@
 
 # -- General configuration ---------------------------------------------------
 
+# add CNAME to sphinx docs
+html_baseurl = "hlink.docs.ipums.org"
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["recommonmark", "sphinx.ext.autodoc"]
+extensions = ["recommonmark", "sphinx.ext.autodoc", "sphinx.ext.githubpages"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]