狮身人面像严重:意外的部分标题 - 功能docstring中的任意标题

Question

使用autodoc和类似的工具允许一个人从源 docStrings 中编译文档。但是，它似乎不允许在功能或类docstrings中任意休息部分标题，并产生错误：

SEVERE: Unexpected section title.

我在尝试按照没有numpydoc的Numpy样式指南进行记录时概述了一个类似的问题：带有sphinx的意外部分标题是numpy的问题Numpy Process Docstrings如何进入参数的Sphinx文档

在这里，我实际上是在记录JavaScript，只想使用任意的部分标题，然后在 docString 中休息。

JavaScript DocString API：Sphinx JSapidoc

Answer 1

是的，在docstring中添加任意部分标题和休息的要求可能会带来挑战；phinx-jsapidoc对此要求有效。