-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from c-cube/wip-doc-ci
add doc generation in CI
- Loading branch information
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: github pages | ||
|
||
on: | ||
push: | ||
branches: | ||
- main # Set a branch name to trigger deployment | ||
pull_request: | ||
|
||
jobs: | ||
deploy: | ||
name: Deploy doc | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@main | ||
|
||
- name: Use OCaml | ||
uses: ocaml/setup-ocaml@v2 | ||
with: | ||
ocaml-compiler: '5.0.x' | ||
allow-prerelease-opam: true | ||
dune-cache: true | ||
|
||
- run: opam pin odoc 2.2.2 -y -n | ||
# crash with 2.4, see https://github.com/ocaml/odoc/issues/1066 | ||
- name: Deps | ||
run: opam install trace trace-tef trace-fuchsia ppx_trace -d | ||
|
||
- name: Build | ||
run: opam exec -- dune build @doc | ||
|
||
- name: Deploy | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./_build/default/_doc/_html/ | ||
destination_dir: . | ||
enable_jekyll: true |