javascript - 狮身人面像严重 : unexpected section title -- arbitrary headings in function docstring

Question

使用 autodoc和类似的工具允许人们从源 docstrings 编译文档。然而，它似乎不允许函数或类文档字符串中的任意 ReST 部分标题，并产生错误:

严重:意外的章节标题。

我尝试在没有 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 文档字符串 API:sphinx jsapidoc

Answer 1

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