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

Question

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

SEVERE: Unexpected section title.

在尝试按照没有numpydoc的{​​numpy样式指南：unexpected section title with sphinx is numpy the issue时，我遇到了类似的问题 how does numpy process docstrings into sphinx documentation for parameters

然而，在这里，我实际上记录了JavaScript，并且只想在 docstring 中拥有任意的章节标题和ReST。

Javascript docstring api：sphinx jsapidoc

Answer 1

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