【问题标题】:Using dub to build documentation使用 dub 构建文档
【发布时间】:2015-04-21 04:01:35
【问题描述】:

我将如何使用 dub 从我的源文件制作 DDocs? dub 中似乎没有默认命令来执行此操作,我真的很希望能够自动执行此过程。

【问题讨论】:

    标签: documentation d documentation-generation dub ddoc


    【解决方案1】:

    通过dub 构建文档实际上是通过构建类型指定的。

    试试dub build --build=docsdub build --build=ddox

    前者构建 'plain' ddocs,后者使用 dub 获取 ddox 来格式化您的文档。

    这实际上显示在帮助中,只是隐藏得很好。查看dub build -h 的“构建”部分(您可以使用dub <command> -h 获取有关特定命令的详细帮助)。

    【讨论】:

    • 由于我的编译器是 GDC,事实证明,如果不对 dub.json 进行一些额外的更改,这将无法工作。具体来说,您必须添加以下内容: "buildTypes": { "docs": { "buildOptions": ["syntaxOnly"], "dflags": ["-c", "-fdoc", "-fdoc-dir= ./docs"] } }
    • 有趣——你可能想向上游报告,因为我认为它应该为你生成正确的标志。
    • dub build --build=docs 将输出放在docs 文件夹中,但dub build --build=ddox 将其输出放在哪里?
    猜你喜欢
    • 2021-11-09
    • 2011-06-09
    • 2011-05-04
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2011-07-16
    • 1970-01-01
    相关资源
    最近更新 更多