mirror of
https://github.com/PhotonVision/photonvision
synced 2026-06-20 00:51:41 +00:00
Update photon-api-docs.yml
This commit is contained in:
29
.github/workflows/photon-api-docs.yml
vendored
29
.github/workflows/photon-api-docs.yml
vendored
@@ -3,7 +3,7 @@ name: Photon API Documentation
|
||||
on:
|
||||
# Run on pushes to main and pushed tags, and on pull requests against main, but ignore the docs folder
|
||||
push:
|
||||
branches: [ main ]
|
||||
branches: [ main, py-docs ]
|
||||
tags:
|
||||
- 'v*'
|
||||
pull_request:
|
||||
@@ -66,6 +66,33 @@ jobs:
|
||||
name: docs-java-cpp
|
||||
path: photon-docs/build/docs
|
||||
|
||||
run_py_docs:
|
||||
name: Build Python API Docs
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install mkdocs mkdocs-material
|
||||
|
||||
- name: Build MkDocs site
|
||||
run: mkdocs build --clean
|
||||
|
||||
- name: Upload built site as artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: docs-python
|
||||
path: site/
|
||||
|
||||
publish_api_docs:
|
||||
name: Publish API Docs
|
||||
needs: [run_java_cpp_docs]
|
||||
|
||||
Reference in New Issue
Block a user