Используя autodoc
и аналогичные инструменты позволяют компилировать документацию из исходных docstrings. Однако он, похоже, не позволяет создавать произвольные заголовки в формате RTST в функциях или классах docstrings и выдает ошибку:
SEVERE: Unexpected section title.
Я попробовал аналогичную проблему, пытаясь документировать следующие правила стиля numpy без numpydoc
: неожиданный заголовок раздела с sphinx, носящий номер и
как процесс numpy docstrings в документацию sphinx для параметров
Здесь, однако, я фактически документирую JavaScript и просто хотел бы иметь произвольные заголовки разделов и ReST в docstring.
Javascript docstring api: sphinx jsapidoc