Skip to content

Build Docs

Build Docs #5

Workflow file for this run

name: Build Docs
on:
workflow_run:
workflows: ["Lint and Format Code"]
types:
- completed
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e ".[docs]"
- name: Convert notebooks to markdown for docs
run: |
jupyter nbconvert --to markdown "examples/cookbook.ipynb" --output-dir="docs/cookbook"
jupyter nbconvert --to markdown "examples/maze_runner.ipynb" --output-dir="docs/cookbook/examples"
- name: Commit changes
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add -A
if git diff --exit-code --staged; then
echo "No changes to commit"
else
git commit -m "[GitHub Action] Converted notebooks to markdown for docs"
git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
fi
- name: Add remote
run: git remote add pkg "https://github.com/WecoAI/aifn-python.git"
- name: Build and deploy
run: |
mkdocs gh-deploy --force -c -v