Skip to content

Deploy several documentations #15

Deploy several documentations

Deploy several documentations #15

Workflow file for this run

name: Build documentation
on: [push, pull_request]
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/"
build-command: "sphinx-build . -W -b html ../../_build/sphinx_docs"
- name: Upload odoc artifact
uses: actions/upload-artifact@v4
with:
name: odoc-artifact
path: _build/default/_doc/_html
- name: Upload sphinx artifact
uses: actions/upload-artifact@v4
with:
name: odoc-artifact
path: _build/sphinx_docs