Skip to content

Deploy several documentations #14

Deploy several documentations

Deploy several documentations #14

Workflow file for this run

name: Build documentation
on: [push, pull_request]
permissions: write-all
env:
OCAML_DEFAULT_VERSION: 4.14.2
# Add OPAMYES=true to the environment, this is usefill to replace `-y` option
# in any opam call
OPAMYES: true
jobs:
build:
runs-on: ubuntu-latest
env:
OPAMWITHDOC: true
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Use OCaml ${{ env.OCAML_DEFAULT_VERSION }}
uses: ocaml/setup-ocaml@v3
with:
ocaml-compiler: ${{ env.OCAML_DEFAULT_VERSION }}
dune-cache: true
- name: Install dependencies
run: opam exec -- make deps
- name: Build odoc documentation
run: opam exec -- dune build @doc
- name: Build sphinx documentation
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/sphinx_docs/"
pre-build-command: "su runner"
build-command: "sphinx-build . -W -b html ../../_build/sphinx_docs"
- name: Debug
run: |
ls -l _build/default/_doc/_html
ls -l _build/sphinx_docs
id
- name: Copy odoc documentation
run: |
cp -Rf _build/default/_doc/_html/* _build/sphinx_docs/API
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: doc-artifact
path: ./_build/sphinx_docs