sphinx严重:意外的部分标题 - 函数docstring中的任意标题

Question

使用autodoc和类似的工具允许从源文档字符串编译文档.但是,它似乎不允许函数或类docstrings中的任意ReST节标题,并产生错误:

SEVERE: Unexpected section title.

我在尝试记录numpy样式指南时遇到了类似的问题numpydoc:没有sphinx的意外部分标题是问题, numpy如何将docstrings处理成sphinx文档中的参数

然而,在这里,我实际上是在记录JavaScript,并且只想在文档字符串中使用任意的节标题和ReST.

Javascript docstring api:sphinx jsapidoc

Answer 1

是的，在文档字符串中添加任意章节标题和 ReST 的要求可能会带来挑战；sphinx-jsapidoc对于这个需求是有效的。