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

Question

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

通常，在一个.rst文件中，如果我这样做

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

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

我的conf.py是

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

由于阅读文档的兼容性，我确实考虑了 mkdocs，但它不提供类似 autodoc 的功能。为了实现这一目标，我对任何其他库都非常开放（不必与 RTD 兼容）。

Answer 1

使用我的ST

pip install myst-parser

将此扩展添加到您的 sphinx 配置中：

extensions = [..., "myst_parser"]

在块内与角色{eval-rst}一起使用autoclass```

``{eval-rst}  
.. autoclass:: my.module.SomeClass
：成员：
````

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

有了它，您可以将以下内容添加到您的降价中：

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