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

2024-05-21 • 问答

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

通常，如果我这样做，在.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兼容）。

zouminfeng 回答：如何在markdown文件中为Sphinx使用自动模块或自动分类？

这可能需要使用AutoStructify的Recommonmark，即RST embedding功能。

使用它，您可以将以下内容添加到减价中：

 ```eval_rst
 .. autoclass:: my.module.SomeClass
 :members:
 ```

将“ .md”添加到source_suffix列表对我有用：

在您的conf.py中：

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
source_suffix = ['.rst','.md']

我正在使用狮身人面像2.1.2

documentation python-sphinx

本文链接：https://www.f2er.com/3069313.html

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

zouminfeng 回答：如何在markdown文件中为Sphinx使用自动模块或自动分类？

大家都在问