-
Notifications
You must be signed in to change notification settings - Fork 86
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
Document required invocations for building docs, and a reference driver. #460
Comments
I just re-read this; it seems we are thinking along similar lines right now. I mentioned in reasonml-community/bsdoc#18 that I am planning to use BuckleScript's vendored Ninja build tool, which you may have heard of because it's actually a separate tool that BuckleScript just happens to bundle. I think it's worth a look–Ninja build rules are simple, and the build is super fast–it's part of what makes BuckleScript itself so fast. For example, here's a rule and target I wrote to build the support files:
If you're interested, I can send more of this sample Ninja build file I hand-wrote while learning the format. |
You should not hard-code |
@dbuenzli thanks, good to know. Will do. |
The way in which odoc should be invoked will be changing as part of the integration of the new model and the new latex/man page generators.
Currently odoc is usually driven by a variety of systems including odig, dune and bsdoc. The exact sequence of calls required is not simple or obvious, and we will be introducing a new link step that sits between the compilation and generation phases.
It's clear we need to document this carefully, but I'd also like to go a step further and produce a 'reference driver' that will execute odoc in the correct sequence. It's likely to be some form of Makefile generation. This is useful for several reasons:
The text was updated successfully, but these errors were encountered: