mirror of
https://github.com/microsoft/mscclpp.git
synced 2026-05-11 17:00:22 +00:00
Fix docs (#656)
* Fix Python doc generation * Remove `ChannelTrigger` and fix `ProxyTrigger` * Fixed package versions for consistency
This commit is contained in:
7
.github/workflows/doc-build.yaml
vendored
7
.github/workflows/doc-build.yaml
vendored
@@ -10,7 +10,7 @@ permissions:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
@@ -18,17 +18,18 @@ jobs:
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.10'
|
||||
python-version: '3.12'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y doxygen graphviz
|
||||
sudo apt-get install -y doxygen=1.9.1-* graphviz
|
||||
pip install -r docs/requirements.txt
|
||||
|
||||
- name: Build docs
|
||||
run: |
|
||||
cd docs
|
||||
rm -rf doxygen _build py_api
|
||||
doxygen
|
||||
make html
|
||||
touch _build/html/.nojekyll
|
||||
|
||||
7
.github/workflows/gh-pages.yml
vendored
7
.github/workflows/gh-pages.yml
vendored
@@ -22,22 +22,23 @@ concurrency:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
- name: Setup python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.10'
|
||||
python-version: '3.12'
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y doxygen graphviz
|
||||
sudo apt-get install -y doxygen=1.9.1-* graphviz
|
||||
pip install -r docs/requirements.txt
|
||||
- name: Build docs
|
||||
run: |
|
||||
cd docs
|
||||
rm -rf doxygen _build py_api
|
||||
doxygen
|
||||
make html
|
||||
touch _build/html/.nojekyll
|
||||
|
||||
44
.github/workflows/update-version.yml
vendored
44
.github/workflows/update-version.yml
vendored
@@ -1,44 +0,0 @@
|
||||
name: Update Version
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- release/**
|
||||
paths:
|
||||
- 'VERSION'
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
update-version:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.head_ref }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Read version
|
||||
id: read_version
|
||||
run: echo "VERSION=$(cat VERSION)" >> $GITHUB_ENV
|
||||
|
||||
- name: Update Version in Files
|
||||
run: |
|
||||
VERSION=${{ env.VERSION }}
|
||||
sed -i "s/^release = \".*\"/release = \"v${VERSION}\"/" docs/conf.py
|
||||
|
||||
- name: Commit and Push Changes
|
||||
run: |
|
||||
git config user.name "github-actions"
|
||||
git config user.email "github-actions@github.com"
|
||||
git add CITATION.cff docs/conf.py || true
|
||||
if git diff --cached --exit-code; then
|
||||
echo "No changes to commit."
|
||||
else
|
||||
git commit -m "Update version to ${{ env.VERSION }}"
|
||||
git push
|
||||
fi
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
Reference in New Issue
Block a user