No description
  • OCaml 81.6%
  • CSS 17.5%
  • Makefile 0.9%
Find a file
2017-09-06 11:29:49 +01:00
docs Initial commit 2017-08-15 13:17:56 -05:00
.gitignore A lot more ocamldoc cleanup 2017-08-22 17:48:23 -05:00
Makefile A lot more ocamldoc cleanup 2017-08-22 17:48:23 -05:00
postprocess.ml Sligtly responsive layout 2017-09-06 01:24:45 +01:00
README.md Initial commit 2017-08-15 13:17:56 -05:00
style.css Tweak responsive breakpoints 2017-09-06 11:29:49 +01:00

Postprocessing and styling of the Lwt manual

The Lwt repo should be a sister directory of this repo lwt-manual.

To use, install the dependencies of Lwt. Jbuilder needs them to generate the ocamldoc output:

opam pin add -n lwt ../lwt
opam install --deps-only lwt

Jbuilder might also as you to install dependencies of lwt_ssl, lwt_react, etc. You can either install the packages as needed, or pin those Lwt subpackages and install that way:

opam pin add -n lwt_react ../lwt
opam install --deps-only lwt_react
# etc.

The postprocessor needs Lambda Soup and re:

opam install lambdasoup re

After that, running make should generate the postprocessed Lwt.html. Since I'm on a Mac, I also have the default target switch to Chrome, which I guess is usually called Google Chrome. Feel free to delete that line if it doesn't work for you, or to make any other edits to the Makefile.

The stylesheet is obviously style.css, and the postprocessor is postprocess.ml.

I've uploaded a branch lwt.mli to the Lwt repo. If you want to work with the new content, you'll want to pull that branch and switch to it before running make.