Как я могу использовать Automodule или Autoclass для Sphinx в файле разметки? ⇐ Python

[Anonymous]

Я понимаю, что SPHINX поддерживает функцию Markdown или .md, которые отлично подходят для меня для моей дополнительной документации. Я пытаюсь использовать теги Autoclass или Automodule в файле разметки. < /p>

Обычно, в файле .rst < /code>, если я сделаю < /p>

Код: Выделить всё

.. autoclass:: my.module.SomeClass
:members:
< /code>

Он автоматически вытащит все Docstrings и создаст документацию. Можно ли использовать это в файлах .md 

? На данный момент, когда я пытаюсь сделать это, сгенерированные документы содержит только .. Autoclass: ... , что ожидается. < /p>

my conf.py < /code> is < /p>

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

Из -за чтения совместимости Docs я рассмотрел MKDOC, но он не предлагает возможности Autodoc, как. Я очень открыт для любой другой библиотеки (не обязательно должна быть RTD), чтобы выполнить это.


Подробнее здесь: https://stackoverflow.com/questions/589 ... kdown-file