如何强制Oasis在给定目录中构建文档?

时间:2015-07-31 10:56:30

标签: ocaml oasis

我正在为OCaml项目使用Oasis构建系统,我想构建文档并在${projectroot}/doc/api/中获取它。

目前,我的_oasis文件是这样的:

OASISFormat: 0.4
Name: MyProject
Version: 0.1alpha
Plugins: META (0.4)
BuildTools: ocamlbuild
AlphaFeatures: ocamlbuild_more_args

PostDistcleanCommand: $rm _tags myocamlbuild.ml setup.ml setup.data

Document api
Title: MyProject API
Type: ocamlbuild (0.4)
BuildTools: ocamldoc
XOCamlbuildPath: src
XOCamlbuildExtraArgs: -docflags -d,doc/api,-colorize-code,-charset,utf-8

然后,我运行以下命令:

$> oasis setup
$> ocaml setup.ml -configure
...
$> ocaml setup.ml -doc
...

然后,我在项目的顶层目录中得到一个链接api.docdir/ --> _build/src/api.docdir/,链接到我期望的文档。但是,似乎没有考虑带有额外参数的-d doc/api

那么,我错过了什么?因为,我在这里有点想法...

1 个答案:

答案 0 :(得分:2)

一种正确的方法是使用install命令将文档(以及其他数据)复制到适当的位置,可以使用configure命令或{{1}自定义}字段。

此外,如果您仍想在项目中迁移文档而不进行安装,则可以使用InstallDir字段,并使用小脚本(或只是一行)来移动文档在一个更好的地方。