如何同时使用Sphinx和Pycco进行Python文档编写？
我想用Sphinx来做主要的项目文档，所以文档字符串必须用reStructuredText格式写。但我也希望能生成HTML文件，这样可以像Pycco那样以Markdown的风格来阅读代码中的注释。
有没有什么工具或者工具组合，可以让我把文档字符串从reStructuredText格式转换成Markdown格式呢？
2 个回答
0
有一个软件叫做 Pandoc，可能正好适合你的需求。你可以通过这个链接查看详细信息。我之前也想试试这个软件，但它需要安装一个叫做Haskell的运行环境，那个环境有点大，所以我就放弃了。
1
pyment这个工具可以把文档字符串转换成不同的格式。你可以先试试这个工具，然后再写一个继承自DocToolsBase的子类，按照你喜欢的方式来格式化文档字符串。
想了解更多关于Python文档字符串的规范和工具，可以看看这个问题：什么是标准的Python文档字符串格式？