如何在标记文件中为Sphinx使用automodule或autoclass？

Question

我理解狮身人面像支持可选的标记或.md文件，这对我的食物文档非常有用。我要做的是在一个标记文件中使用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',
}

由于读取文档的兼容性，我确实考虑了mkdocs，但它不提供类似于autodoc的功能。为了实现这一点，我对任何其他库都非常开放(不需要与RTD兼容)。

Answer 1

如果你在使用MyST

extensions = [
    'myst_parser',
    ...
]

你要做的就是：

```{eval_rst}

。。自动类：：my.module.SomeClass

*成员：