草庐IT

autosummary

全部标签

python - 使用Sphinx为每个函数自动生成单独的文档

我一直在构建一个具有许多不同功能的Python模块。我正在使用Sphinx和readthedocs来提供文档。我取得了不错的进展,但目前我有onemassivepage它提供了我所有功能的文档(按字母顺序排列)。我看过其他项目,每个功能都有一个单独的页面。在查看它们的源代码时,我发现每个都创建了一个单独的.rst文件。我假设这是自动完成的,thispage关于生成autodoc摘要似乎描述了其中的一些内容,但我就是无法理解。sphinx-apidoc有一个选项(-e)可以为每个模块创建一个页面,但我想为每个功能创建一个页面。如何使用Sphinx为每个功能自动生成单独的页面?附加信息要为

python - 递归地使用 Sphinx autosummary 生成 API 文档

我想使用Sphinx的autosummaryextension和templates从文档字符串递归生成API文档。我想为每个模块、类、方法、属性和函数创建单独的页面。但它根本没有检测到我的模板。事实上,如果我只是从_templates/autosummary/中删除module.rst文件,它会以与以前完全相同的方式呈现整个文件。我关注了thisSOquestion不折不扣。如果您有兴趣,thefullrepositoryisonGitHub.编辑:它似乎确实生成了一个不同的文件,我必须删除docs/_autosummary才能读取新模板。但是,现在它会生成一个带有sparsehead

Python sphinx 自动摘要错误

我有一个sphinx文档,当我包含以下几行时:..currentmodule::myMod..autosummary::MyClass出现以下错误ERROR:Unknowndirectivetype"autosummary".然而,autosummary从0.6版本开始可用,我使用Sphinx1.1.3。什么可能导致问题?谢谢!编辑:为了更清楚一点,我说的是python-sphinx,文档工具。 最佳答案 sphinx.ext.autosummary是Sphinxextension.为了使用扩展,您必须将其名称添加到extensio