首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >使用Asciidoctor插件以HTML格式发布API文档时未解决的指令错误

使用Asciidoctor插件以HTML格式发布API文档时未解决的指令错误
EN

Stack Overflow用户
提问于 2016-02-01 18:39:56
回答 2查看 4.5K关注 0票数 4

我已经成功地使用Spring编写了一个测试并生成了代码段。

当我使用Asciidoctor Maven plugin以HTML格式发布API文档时,将生成HTML。

但是,HTML显示了以下错误。我的包含似乎不像预期的那样起作用。我想知道会有什么问题。

api-guide.adoc - include::/opt/caweb/thoughtworks/go-agent/pipelines/xxx_Build/xxx-source/target/generated-snippets/creating-grouping/curl-request.adoc[]中未解析的指令

这里是POM.xml的asciidoctor-maven-plugin和maven-resources-plugin部分。

代码语言:javascript
运行
复制
<plugin> 
            <groupId>org.asciidoctor</groupId>
            <artifactId>asciidoctor-maven-plugin</artifactId>
            <version>1.5.2</version>
            <executions>
                <execution>
                    <id>generate-docs</id>

                    <phase>prepare-package</phase> 
                    <goals>
                        <goal>process-asciidoc</goal>
                    </goals>
                    <configuration>
                        <backend>html</backend>
                        <doctype>book</doctype>
                        <attributes>
                            <snippets>${project.build.directory}/generated-snippets</snippets>
                        </attributes>
                    </configuration>
                </execution>
            </executions>
        </plugin>

        <plugin>
            <artifactId>maven-resources-plugin</artifactId>
            <version>2.7</version>
            <executions>
                <execution>
                    <id>copy-resources</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>copy-resources</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>${project.build.outputDirectory}/static/docs</outputDirectory>
                        <resources>
                            <resource>
                                <directory>${project.build.directory}/generated-docs</directory>
                            </resource>
                        </resources>
                    </configuration>
                </execution>
            </executions>
        </plugin>

下面是我的api-Guide.adoc的包含部分:

代码语言:javascript
运行
复制
include::{snippets}/create-grouping/curl-request.adoc[]

谢谢你的帮助!

EN

回答 2

Stack Overflow用户

发布于 2016-02-08 12:33:44

您是否正在配置您确定的插件以包括您的文档文件?

https://github.com/spring-projects/spring-restdocs/blob/master/docs/src/docs/asciidoc/getting-started.adoc

检查这里

票数 0
EN

Stack Overflow用户

发布于 2016-06-24 11:44:25

我解决了这一问题,我将asciidoctor上的相位从prepare-package改为

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/35137874

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档