相关疑难解决方法(0)

基于Sphinx的文档的Markdown输出

我发现自己有一个用例,除了从基于Sphinx的文档源生成HTML和PDF之外,我还想生成reStructuredText源文件的Markdown版本.

我的初步研究没有在Sphinx中找到任何核心或扩展支持.除了手动使用pandoc或为任务创建新的Sphinx扩展外,是否有更简单/更集成的解决方案?

documentation markdown restructuredtext python-sphinx

26
推荐指数
2
解决办法
7610
查看次数

markdown/pandoc的整个网站编译?

使用Sphinx-doc,您可以创建一堆ReStructureText文件,index.rst其中包含一个目录宏的文件,该宏自动生成来自其他包含文件的目录,以及一个conf.py充当编译配置的文件.然后,您可以将该批次编译为单个python-doc样式的站点,包括索引,导航工具和搜索功能.

有没有类似的降价工具(最好是pandoc式降价)?

documentation markdown pandoc pelican

14
推荐指数
2
解决办法
5985
查看次数

强制Sphinx用Python文档字符串解释Markdown而不是reStructuredText

我正在使用Sphinx来记录python项目。我想在我的文档字符串中使用Markdown格式化它们。即使使用recommonmark扩展名,它也仅涵盖.md手动编写的文件,而不包括文档字符串。

我使用autodocnapoleonrecommonmark在我的扩展。

如何在我的文档字符串中使Sphinx解析markdown

python markdown python-sphinx

3
推荐指数
1
解决办法
315
查看次数