mirror of
https://github.com/Z3Prover/z3
synced 2025-12-25 05:26:51 +00:00
2a3f874883
* Initial plan * Deploy docs to z3prover.github.io organization pages Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>
54 lines
1.3 KiB
YAML
54 lines
1.3 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [master]
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: false
|
|
|
|
env:
|
|
EM_VERSION: 3.1.73
|
|
|
|
jobs:
|
|
build-docs:
|
|
name: Build Documentation
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v6
|
|
|
|
- name: Setup node
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version: "lts/*"
|
|
|
|
- name: Install system dependencies
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install -y doxygen graphviz python3 python3-pip
|
|
|
|
- name: Build Z3 natively for Python documentation
|
|
run: |
|
|
python3 scripts/mk_make.py --python
|
|
cd build && make -j$(nproc)
|
|
cd ../src/api/python && python3 -m pip install --user .
|
|
|
|
- name: Generate Documentation (from doc directory)
|
|
working-directory: doc
|
|
run: python3 mk_api_doc.py --output-dir=api
|
|
|
|
- name: Deploy to z3prover.github.io
|
|
uses: peaceiris/actions-gh-pages@v4
|
|
with:
|
|
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
|
|
external_repository: Z3Prover/z3prover.github.io
|
|
publish_branch: master
|
|
publish_dir: ./doc/api/html
|
|
user_name: github-actions[bot]
|
|
user_email: github-actions[bot]@users.noreply.github.com
|