0

这是我在 StackOverflow 上的第一个问题。

我正在使用 Java 11、Spring Boot 2.4.0、JUnit 5、Auto Rest Docs 2.0.9。

我在生成文档时收到以下警告：

asciidoctor: WARNING: C:/{path-to-project}/build/generated-snippets/register_success/auto-section.adoc: line 2: section title out of sequence: expected level 2, got level 3

第 2 行如下所示：==== Register

文档的结构如下所示：

= API Methods
== Account Registration Operations
include::{snippets}/register_success/auto-section.adoc[]

== Other level 1 section
=== Level 2 section
include::{snippets}/{other-method-name}/auto-section.adoc[]

所有直接包含在Level 1 section.

对于里面的片段，Level 2 section一切都很好。

我理解为什么会出现警告，但是如何在自动生成的代码段中配置标题级别？

如果有办法将其配置为部分标题为 2 级，它可能会为Level 2 section(like expected level 3, got level 2) 中的片段显示警告。

有没有办法自动配置自动生成的片段中的部分标题级别？（基于包含的父节级别）

甚至是一种在每个单元测试中指定预期级别的方法。

我检查了文档，但没有找到任何东西。任何帮助表示赞赏。谢谢！

4

1 回答 1

0

可以通过片段自定义配置标题级别，即通过提供具有不同级别标题的自定义片段模板。但是，这将适用于所有地方。或者，可以创建一个自定义片段，该片段可以配置为使用不同的模板。主要问题是代码片段看不到周围的 AsciiDoc，因此永远不知道它在哪个级别。

这是当前的Auto Section Snippet，标题位于第三级。

我们尝试将所有片段放在同一级别。然而，这并不总是奏效或始终如一地应用。所以在实践中，我们忽略了这些警告。

于 2020-12-28T13:40:03.730 回答