将文本文档字符串重组为 .md 文件
restructuredText docstrings to .md files
我有一个 Python 项目,我在 comment/documentate 每个 classes/functions 中使用 restructuredText。这是我的文档字符串的示例:
"""
Updates the contacts birth date in batch
:param nb_contacts: nb_contacts: number of contacts to update
:param batch_size: size of the batch
:param context: airflow context
:return: true if update is successful
"""
我想从我的代码生成 .md 文件。有办法吗?
Sphinx is probably what you are looking for, additionally it is possible to publish the generated documentation to ReadTheDocs,你可能已经很熟悉了。
任何 .rst
文件都可以使用 pandoc 严格转换为 .md
(或任何其他格式),您可以执行以下操作:
pandoc -f page.rst -t page.md
从 reStructuredText 生成 Markdown 似乎是一种不常见的组合。您会在 Markdown output for Sphinx based documentation
上找到与您的问题类似的问题
我有一个 Python 项目,我在 comment/documentate 每个 classes/functions 中使用 restructuredText。这是我的文档字符串的示例:
"""
Updates the contacts birth date in batch
:param nb_contacts: nb_contacts: number of contacts to update
:param batch_size: size of the batch
:param context: airflow context
:return: true if update is successful
"""
我想从我的代码生成 .md 文件。有办法吗?
Sphinx is probably what you are looking for, additionally it is possible to publish the generated documentation to ReadTheDocs,你可能已经很熟悉了。
任何 .rst
文件都可以使用 pandoc 严格转换为 .md
(或任何其他格式),您可以执行以下操作:
pandoc -f page.rst -t page.md
从 reStructuredText 生成 Markdown 似乎是一种不常见的组合。您会在 Markdown output for Sphinx based documentation
上找到与您的问题类似的问题