您好, 欢迎来到 !    登录 | 注册 | | 设为首页 | 收藏本站

使用Sphinx为每个功能自动生成单独的文档

使用Sphinx为每个功能自动生成单独的文档

在使用sphinx和’autodoc’的按类排序显示的答案中?它说明了如何使用autosummary和来为每个类一页生成类的文档autosummary_generate=True

该机制也适用于功能。使用这样的东西:

EoN API documentation
=====================

.. currentmodule:: EoN

.. autosummary::
   :toctree: functions

   my_function1
   my_function2
   my_function3
   ...

您必须在autosummary指令中枚举每个函数,但是相应的*.rst文件自动生成(在functions子目录中)。

其他 2022/1/1 18:26:37 有356人围观

撰写回答


你尚未登录,登录后可以

和开发者交流问题的细节

关注并接收问题和回答的更新提醒

参与内容的编辑和改进,让解决方法与时俱进

请先登录

推荐问题


联系我
置顶