pdoc

actions/uv/pdoc/action.yml

@@ -0,0 +1,54 @@
+#  Copyright 2023 Stanford University Convex Optimization Group
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+name: Build pdoc documentation
+
+description: "Build pdoc documentation"
+
+on:
+  workflow_call:
+    inputs:
+      source-folder:
+        description: 'Source folder'
+        type: string
+        required: false
+        default: 'cvx'
+      pdoc-arguments:
+        description: 'pdoc arguments'
+        type: string
+        required: false
+        default: ''
+runs:
+  using: "composite"
+
+  steps:
+      #- uses: actions/checkout@v4
+
+      - uses: cvxgrp/.github/actions/uv/setup@main
+
+      - name: Install pdoc
+        shell: bash
+        run: |
+          uv pip install --no-cache-dir pdoc
+
+      - name: Build pdoc
+        shell: bash
+        run: |
+          uv run pdoc -o artifacts/pdoc ${{ inputs.pdoc-arguments || '' }} ${{ inputs.source-folder || 'cvx' }}
+
+      - name: Archive sphinx documentation
+        uses: actions/upload-artifact@v4
+        with:
+          name: pdoc
+          path: artifacts/pdoc
+          retention-days: 1