Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/driver.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: "Driver"

on:
- pull_request

jobs:
build: # Check build on various OSes

strategy:
matrix:
os:
- ubuntu-latest
ocaml-compiler:
- 5.2.x

runs-on: ${{ matrix.os }}

steps:
# Clone the project
- uses: actions/checkout@v4
with:
submodules: true

# Setup
- name: Setup OCaml ${{ matrix.ocaml-version }}
uses: ocaml/setup-ocaml@v3
with:
ocaml-compiler: ${{ matrix.ocaml-compiler }}
opam-local-packages: odoc-parser.opam odoc.opam odoc-driver.opam sherlodoc/sherlodoc.opam

- name: Install dependencies
run: |
opam install -y --deps-only -t ./odoc-parser.opam ./odoc.opam ./odoc-driver.opam sherlodoc/sherlodoc.opam
opam install -y base # Input to the driver

- name: Run the driver
run: |
opam exec -- dune exec -- odoc_driver -p base
echo "Generated $(find _html -name '*.html' | wc -l) pages"
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "sherlodoc"]
path = sherlodoc
url = https://github.com/Julow/sherlodoc
branch = odoc3_compat
2 changes: 2 additions & 0 deletions dune
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@
(progn
(bash "diff doc/driver.mld doc/driver.mld.corrected >&2 || true")
(cat doc/driver-benchmarks.json))))

(vendored_dirs sherlodoc)
1 change: 1 addition & 0 deletions odoc-driver.opam
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ depends: [
"progress"
"cmdliner"
"sexplib"
"sherlodoc"
]

build: [
Expand Down
1 change: 1 addition & 0 deletions sherlodoc
Submodule sherlodoc added at 5fc34e
3 changes: 2 additions & 1 deletion src/driver/dune
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
(public_name odoc_driver)
(package odoc-driver)
(link_deps
(package odoc))
(package odoc)
(package sherlodoc))
(libraries
cmdliner
bos
Expand Down
Loading