使用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,并且只想在文档字符串中使用任意的节标题和ReST。
Javascript docstring api:sphinx jsapidoc
是的,在文档字符串中添加任意节标题和ReST的要求可能会带来挑战; sphinx-jsapidoc对此要求有效。