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

问题描述 投票:10回答:1

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

SEVERE: Unexpected section title.

我试图在没有numpydoc的情况下遵循numpy风格指南时遇到了类似的问题:unexpected section title with sphinx is numpy the issuehow does numpy process docstrings into sphinx documentation for parameters

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

Javascript docstring api:sphinx jsapidoc

javascript python python-sphinx restructuredtext autodoc
1个回答
0
投票

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

© www.soinside.com 2019 - 2024. All rights reserved.