我如何在markdown文件中为Sphinx使用自动模块或自动分类?

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

我了解Sphinx可选地支持markdown或.md文件,这对我的补充文档非常有用。我想做的是在markdown文件中使用autoclassautomodule标签。

通常,如果是,在.rst文件中

.. autoclass:: my.module.SomeClass
    :members:

它会自动提取所有文档字符串并创建文档。可以在.md文件中使用它吗?目前,当我尝试这样做时,生成的文档仅包含预期的.. autoclass:...

我的conf.py

extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "recommonmark"]
source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}

由于阅读了docs兼容性,我确实考虑了mkdocs,但它不提供类似autodoc的功能。为了达到这个目的,我对任何其他库都非常开放(不必与RTD兼容)。

python documentation python-sphinx
1个回答
© www.soinside.com 2019 - 2024. All rights reserved.