mirror of
https://github.com/Z3Prover/z3
synced 2025-12-25 05:26:51 +00:00
77 lines
2.2 KiB
YAML
77 lines
2.2 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
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@v4
|
|
|
|
- name: Setup node
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: "lts/*"
|
|
|
|
# Setup OCaml via action
|
|
- uses: ocaml/setup-ocaml@v3
|
|
with:
|
|
ocaml-compiler: 5
|
|
opam-disable-sandboxing: true
|
|
|
|
- name: Install system dependencies
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install -y doxygen graphviz python3 python3-pip
|
|
sudo apt-get install -y \
|
|
bubblewrap m4 libgmp-dev pkg-config ninja-build ccache
|
|
|
|
- name: Install required opam packages
|
|
run: opam install -y ocamlfind zarith
|
|
|
|
- name: Build Z3 natively for Python documentation
|
|
run: |
|
|
eval $(opam env)
|
|
echo "CC: $CC"
|
|
echo "CXX: $CXX"
|
|
echo "OCAMLFIND: $(which ocamlfind)"
|
|
echo "OCAMLC: $(which ocamlc)"
|
|
echo "OCAMLOPT: $(which ocamlopt)"
|
|
echo "OCAML_VERSION: $(ocamlc -version)"
|
|
echo "OCAMLLIB: $OCAMLLIB"
|
|
mkdir build
|
|
python3 scripts/mk_make.py --python --ml
|
|
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 --mld --output-dir=api --z3py-package-path=../build/python/z3
|
|
mkdir api/html/ml
|
|
ocamldoc -html -d api/html/ml -sort -hide Z3 -I $( ocamlfind query zarith ) -I ../build/api/ml ../build/api/ml/z3enums.mli ../build/api/ml/z3.mli
|
|
|
|
- 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
|
|
destination_dir: ./api
|
|
publish_branch: master
|
|
publish_dir: ./doc/api
|
|
user_name: github-actions[bot]
|
|
user_email: github-actions[bot]@users.noreply.github.com
|