如何将Sphinx和Pycco用于Python文档？

Question

我希望能够将Sphinx用作主项目文档，因此文档字符串必须在reStructuredText中，但我也想生成HTML以便以Pycco的风格阅读内联注释，该注释使用Markdown。

是否有工具或工具组合可以让我只将文档字符串从reStructuredText转换为Markdown？

Answer 1

一个名为Pandoc的软件可能是正确的工具。您可以通过超链接查看页面中的详细信息。我曾经想尝试过它，但它需要Haskell运行时环境，这有点大，所以我放弃了。

Answer 2

pyment工具可以将文档字符串转换为不同的格式。你可以从那开始，然后编写一个DocToolsBase的子类来按照你喜欢的方式格式化docstrings。

有关python docstring约定和工具的更多信息，请参阅此问题What is the standard Python docstring format?。