Spring REST Docs - 如何配置asciidoctor任务以将生成的片段包含到索引中?

时间:2018-03-10 11:20:53

标签: junit5 asciidoctor spring-restdocs

我的index.adoc文件位于: src/docs/asciidoc/index.adoc

内容为:include::{snippets}/add-measurement/curl-request.adoc[]

当我调用构建任务时,生成的代码段位于:build/generated-snippets/my-call/*.adoc

但是当我查看生成的index.html时,结果发现不包含片段:

Unresolved directive in index.adoc - include::{snippets}/add-measurement/curl-request.adoc[]

asciidoctor中的build.gradle任务:

asciidoctor {
    dependsOn junitPlatformTest
}

当我将sourceDir snippetsDir添加到asciidoctor gradle任务时,每个代码段都会转换为html,但不会生成index.html

1 个答案:

答案 0 :(得分:2)

根据您的信息,snippetsDir已配置,并且代码段已放置在预期文件夹中,并且AsciiDoctor sourceDir已正确生成index.html(但包含已损坏的内容)。所以似乎缺少的一件事就是将snippetDir传递给AsciiDoctor:

asciidoctor {
  inputs.dir snippetsDir
  dependsOn junitPlatformTest  
}

asciidoctor {
  attributes "snippets": snippetsDir
  dependsOn junitPlatformTest  
}

使用Gradle设置的示例: