Python 将dtext docstrings重新构造为.md文件
我有一个Python项目,在那里我使用restructuredText对我的每个类/函数进行注释/记录。以下是我的docstring示例:Python 将dtext docstrings重新构造为.md文件,python,markdown,documentation,restructuredtext,Python,Markdown,Documentation,Restructuredtext,我有一个Python项目,在那里我使用restructuredText对我的每个类/函数进行注释/记录。以下是我的docstring示例: """ 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: airfl
"""
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文件。还有其他方法吗?可能是您正在寻找的,此外,还可以将生成的文档发布到您可能已经熟悉的位置
任何.rst
文件都可以严格转换为.md
(或任何其他格式),您可以执行以下操作:
pandoc-f page.rst-t page.md
可能是您正在寻找的,此外,您还可以将生成的文档发布到您可能已经熟悉的位置
任何.rst
文件都可以严格转换为.md
(或任何其他格式),您可以执行以下操作:
pandoc-f page.rst-t page.md
从重构文本生成降价似乎是一种不常见的组合。你会在上发现一个类似于你的问题,从StructuredText生成降价似乎是一个不常见的组合。你会在上找到一个与你类似的问题,期望的输出是什么?只是寻找一些可以在git和可读的.md doc文件上很好地显示的东西。与使用sphinx生成的.html文档具有相同结构但在.md文件中的文档请注意注释和docstring是两种不同的东西。你的问题是一个docstring。预期的输出是什么?只是寻找一些可以很好地显示在git和人类可读的.md doc文件上的东西。与使用sphinx生成的.html文档具有相同结构但在.md文件中的文档请注意注释和docstring是两种不同的东西。你的问题是一个docstring。但是Sphinx只生成.rst文件没有?我们能用这些.rst文件转换成markdown吗?@Arès更新了我的答案。但是Sphinx只生成.rst文件没有?我们能用这些.rst文件转换成markdown吗?@Arès更新了我的答案。