Add CI for docs

.github/workflows/build-docs.yml

@@ -0,0 +1,36 @@
+name: Build Docs
+on:
+  workflow_call:
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-22.04
+
+    env:
+      GH_TOKEN: "${{ secrets.GITHUB_TOKEN}}"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: "3.10"
+          cache: true
+
+      - name: Install deps
+        run: pdm install -d
+
+      - name: Build docs
+        run: pdm docs
+
+      - name: set .nojeckyll for GitHub
+        run: touch docs/build/.nojekyll
+
+      - name: Upload docs artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: docs/build
+

.github/workflows/deploy-docs-internal.yml

@@ -0,0 +1,31 @@
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+name: deploy-internal
+run-name: Deploy docs internally
+jobs:
+  build-docs:
+    uses: ./.github/workflows/build-docs.yml
+
+  deploy-internal:
+    runs-on: ubuntu-latest
+    needs: build-docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download docs artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: docs/build
+
+      - uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: docs/build
+          branch: gh-pages
+          clean-exclude: pr-preview
+          force: false

.github/workflows/preview-docs.yml

@@ -0,0 +1,35 @@
+# .github/workflows/preview.yml
+name: Deploy PR previews
+concurrency: preview-${{ github.ref }}
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+
+jobs:
+  build-docs:
+    uses: ./.github/workflows/build-docs.yml
+
+  deploy-preview:
+    runs-on: ubuntu-latest
+    needs: build-docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download docs artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: docs/build
+
+      - uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: docs/build
+          preview-branch: gh-pages
+          umbrella-dir: pr-preview
+          action: auto
+          pages-base-url: chipflow-docs.docs.chipflow-infra.com

docs/requirements.txt

@@ -2,5 +2,4 @@ git+https://github.com/SymbiFlow/sphinx_materialdesign_theme.git#egg=sphinx-symb
 
 docutils
 sphinx
-sphinx-autobuild
 sphinxcontrib-wavedrom

docs/source/conf.py

@@ -44,9 +44,10 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-  'sphinxcontrib.wavedrom',
+  'sphinxcontrib.yowasp_wavedrom',
   'sphinx.ext.mathjax',
-  'sphinx.ext.todo'
+  'sphinx.ext.todo',
+  'sphinx_design',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -82,7 +83,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 todo_include_todos = False
 

docs/source/index.rst

@@ -292,24 +292,23 @@ Run XOR check,
 Checklist for Open-MPW Submission
 =================================
 
+  | :octicon:`checkbox` The project repo adheres to the same directory structure in this repo.
 
-|:heavy_check_mark:| The project repo adheres to the same directory structure in this repo.
-
-|:heavy_check_mark:| The project repo contain info.yaml at the project root.
+  | :octicon:`checkbox` The project repo contain info.yaml at the project root.
 
-|:heavy_check_mark:| Top level macro is named ``user_analog_project_wrapper``.
+  | :octicon:`checkbox` Top level macro is named ``user_analog_project_wrapper``.
 
-|:heavy_check_mark:| Full Chip Simulation passes for RTL and GL (gate-level)
+  | :octicon:`checkbox` Full Chip Simulation passes for RTL and GL (gate-level)
 
-|:heavy_check_mark:| The project contains a spice netlist for the ``user_analog_project_wrapper`` at netgen/user_analog_project_wrapper.spice
+  | :octicon:`checkbox` The project contains a spice netlist for the ``user_analog_project_wrapper`` at netgen/user_analog_project_wrapper.spice
 
-|:heavy_check_mark:| The hardened Macros are LVS and DRC clean
+  | :octicon:`checkbox` The hardened Macros are LVS and DRC clean
 
-|:heavy_check_mark:| The ``user_analog_project_wrapper`` adheres to empty wrapper template  order specified at  `user_analog_project_wrapper_empty <https://github.com/efabless/caravel/blob/master/mag/user_analog_project_wrapper_empty.mag>`__
+  | :octicon:`checkbox` The ``user_analog_project_wrapper`` adheres to empty wrapper template  order specified at  `user_analog_project_wrapper_empty <https://github.com/efabless/caravel/blob/master/mag/user_analog_project_wrapper_empty.mag>`__
 
-|:heavy_check_mark:| XOR check passes with zero total difference.
+  | :octicon:`checkbox` XOR check passes with zero total difference.
 
-|:heavy_check_mark:| Open-MPW-Precheck tool runs successfully. 
+  | :octicon:`checkbox` Open-MPW-Precheck tool runs successfully.
 
 
 .. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg