https://github.com/smondet/build-docs-workflow

Use Ketrew to build the documentation of a bunch of projects
https://github.com/smondet/build-docs-workflow

Last synced: 26 days ago
JSON representation

Use Ketrew to build the documentation of a bunch of projects

• Host: GitHub
• URL: https://github.com/smondet/build-docs-workflow
• Owner: smondet
• License: isc
• Created: 2014-10-07T22:21:37.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-02-11T22:31:43.000Z (almost 9 years ago)
• Last Synced: 2023-03-12T03:03:28.353Z (almost 2 years ago)
• Language: OCaml
• Size: 20.5 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Build Websites With Ketrew

==========================

This script uses Ketrew to build the documentation of a bunch of projects.

Type-check:

    ocaml build_all_docs.ml

Run:

    ocaml build_all_docs.ml go   

The script expects a Ketrew server running at `` and accepting ``

as authentication token.

`` is the *work* directory.

For example, if Ketrew is running locally, with its “test” configuration:

    ocaml build_all_docs.ml go https://localhost:8443 netok /some/tmp/

And go to see `file:///some/tmp/results/index.html` when/if it succeeds.

 

MacOSX Note

-----------

This problem is not specific to this script; it's more related to OCamldoc's

file naming scheme and MacOSX case-insensitive file-system:

If two module-items have names which differ only by case, OCamldoc-generated

HTML files will be erasing each other (for example when a submodule and a

module type follow ML conventions).

**The Solution:**

- Create a case-insensitive disk image (see for example

[here](https://coderwall.com/p/mgi8ja)).

- Use it as ``.