Working on CI for doc deployment.

Author: eriq-augustine

.ci/build_site.sh

@@ -21,15 +21,12 @@ readonly MODULE_TITLE_LOCATION='<section class="module-info">'
 readonly API_DOC_MARKER='<!-- API-DOC-MARKER -->'
 
 function check_git() {
-    # TEST
-    return 0
-
-    if [ ! -z "$(git status --porcelain)" ] ; then 
+    if [ ! -z "$(git status --porcelain)" ] ; then
         echo "ERROR: Repository is not clean."
         exit 1
     fi
 
-    if [ $(git branch --show-current) == 'main' ] ; then
+    if [ $(git branch --show-current) != 'main' ] ; then
         echo "ERROR: Repository is not on the main branch."
         exit 2
     fi

.github/workflows/main.yml

@@ -53,3 +53,63 @@ jobs:
         if: runner.os == 'Linux'
         shell: bash
         run: ./scripts/gen_docs.sh
+
+  docs:
+    needs: [test]
+    if: ${{ github.event_name == 'push' && github.repository_owner == 'edulinq' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')) }}
+
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    strategy:
+      matrix:
+        python-version: ['3.11']
+        os: ['ubuntu-24.04']
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Cache Python Dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ runner.os }}-os:${{ matrix.os }}-python:${{ matrix.python-version }}-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('requirements-dev.txt') }}
+
+      - name: Install Dependencies
+        shell: bash
+        run: pip install -r requirements.txt -r requirements-dev.txt
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Build Site
+        shell: bash
+        run: |
+            git checkout main
+            ./.ci/build_site.sh
+
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: '._site'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

scripts/gen_docs.sh

@@ -4,6 +4,7 @@
 
 readonly THIS_DIR="$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd | xargs realpath)"
 readonly ROOT_DIR="${THIS_DIR}/.."
+readonly FAVICON_PATH="${ROOT_DIR}/.ci/html/images/favicon.ico"
 
 function main() {
     if [[ $# -gt 1 ]]; then
@@ -14,16 +15,18 @@ function main() {
     set -e
     trap exit SIGINT
 
-    local outputDir="${ROOT_DIR}/html"
+    local output_dir="${ROOT_DIR}/html"
     if [[ $# -gt 0 ]]; then
-        outputDir=$1
+        output_dir=$1
     fi
 
     cd "${ROOT_DIR}"
 
-    mkdir -p "${outputDir}"
+    mkdir -p "${output_dir}"
+
+    pdoc --output-directory "${output_dir}" --favicon "$(basename "${FAVICON_PATH}")" ./pacai edq !.*_test
+    cp "${FAVICON_PATH}" "${output_dir}"
 
-    pdoc --output-directory "${outputDir}" ./pacai edq !.*_test
     return $?
 }