Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New driving page #1209

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
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
33 changes: 0 additions & 33 deletions doc/deps.mld

This file was deleted.

1,414 changes: 363 additions & 1,051 deletions doc/driver.mld

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions doc/library_mlds/base.mld

This file was deleted.

5 changes: 0 additions & 5 deletions doc/library_mlds/base_quickcheck.mld

This file was deleted.

2 changes: 0 additions & 2 deletions doc/library_mlds/bin_prot.mld

This file was deleted.

10 changes: 0 additions & 10 deletions doc/library_mlds/biniou.mld

This file was deleted.

1 change: 0 additions & 1 deletion doc/library_mlds/cmdliner.mld

This file was deleted.

1 change: 0 additions & 1 deletion doc/library_mlds/core.mld

This file was deleted.

15 changes: 0 additions & 15 deletions doc/library_mlds/dune

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/fmt.mld

This file was deleted.

1 change: 0 additions & 1 deletion doc/library_mlds/fpath.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/ocamlary.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc-parser.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_document.mld

This file was deleted.

4 changes: 0 additions & 4 deletions doc/library_mlds/odoc_examples.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_html.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_html_frontend.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_html_support_files.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_json_index.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_latex.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_loader.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_manpage.mld

This file was deleted.

8 changes: 0 additions & 8 deletions doc/library_mlds/odoc_model.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_model_desc.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_odoc.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_parser.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_search.mld

This file was deleted.

10 changes: 0 additions & 10 deletions doc/library_mlds/odoc_xref2.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/odoc_xref_test.mld

This file was deleted.

5 changes: 0 additions & 5 deletions doc/library_mlds/ppx_hash.mld

This file was deleted.

5 changes: 0 additions & 5 deletions doc/library_mlds/ppx_sexp_conv.mld

This file was deleted.

3 changes: 0 additions & 3 deletions doc/library_mlds/print.mld

This file was deleted.

1 change: 0 additions & 1 deletion doc/library_mlds/result.mld

This file was deleted.

2 changes: 0 additions & 2 deletions doc/library_mlds/sexplib.mld

This file was deleted.

2 changes: 0 additions & 2 deletions doc/library_mlds/sexplib0.mld

This file was deleted.

Loading
Loading