Simplify our docs with complicated functions into utils (#1807)

Co-authored-by: Chayenne <zhaochenyang@ucla.edu>
This commit is contained in:
Chayenne
2024-10-26 10:44:11 -07:00
committed by GitHub
parent 9084a86445
commit ced362f7c6
5 changed files with 159 additions and 103 deletions

View File

@@ -1,12 +1,18 @@
name: Build Documentation
name: Release Documentation
on:
push:
branches:
- main
paths:
- 'docs/**'
- 'python/sglang/version.py'
workflow_dispatch:
jobs:
execute-notebooks:
runs-on: 1-gpu-runner
if: github.repository == 'sgl-project/sglang' || github.event_name == 'pull_request'
if: github.repository == 'sgl-project/sglang'
steps:
- name: Checkout code
uses: actions/checkout@v3
@@ -38,8 +44,9 @@ jobs:
done
build-and-deploy:
needs: execute-notebooks
if: github.repository == 'sgl-project/sglang'
runs-on: 1-gpu-runner
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
@@ -75,4 +82,4 @@ jobs:
git commit -m "Update $(date +'%Y-%m-%d %H:%M:%S')"
git push https://$GITHUB_TOKEN@github.com/sgl-project/sgl-project.github.io.git main
cd ..
rm -rf sgl-project.github.io
rm -rf sgl-project.github.io

42
.github/workflows/execute-notebook.yml vendored Normal file
View File

@@ -0,0 +1,42 @@
name: Execute Notebooks
on:
pull_request:
push:
branches:
- main
workflow_dispatch:
jobs:
run-all-notebooks:
runs-on: 1-gpu-runner
if: github.repository == 'sgl-project/sglang' || github.event_name == 'pull_request'
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.9'
- name: Install dependencies
run: |
bash scripts/ci_install_dependency.sh
pip install -r docs/requirements.txt
- name: Setup Jupyter Kernel
run: |
python -m ipykernel install --user --name python3 --display-name "Python 3"
- name: Execute notebooks
run: |
cd docs
for nb in *.ipynb; do
if [ -f "$nb" ]; then
echo "Executing $nb"
jupyter nbconvert --to notebook --execute --inplace "$nb" \
--ExecutePreprocessor.timeout=600 \
--ExecutePreprocessor.kernel_name=python3
fi
done