我讨厌reST,但喜欢Sphinx。是否有一种方法,狮身人面像读取Markdown而不是reStructuredText?
当前回答
现在正式支持:http://www.sphinx-doc.org/en/stable/markdown.html
也见https://myst-parser.readthedocs.io/en/latest/syntax/optional.html的扩展,包括linkify使url自动链接。
其他回答
这里有一个新的选择。MyST为Markdown添加了一些功能,允许Sphinx像rst一样构建文档。 https://myst-parser.readthedocs.io/en/latest/
这没有使用Sphinx,但是MkDocs将使用Markdown构建您的文档。我也讨厌rst,到目前为止我真的很喜欢MkDocs。
这是对推荐方法的更新。
pip install recommonmark
我个人使用Sphinx 3.5.1,所以
# for Sphinx-1.4 or newer
extensions = ['recommonmark']
点击这里查看官方文件。
2021年5月更新:推荐标记已弃用,取而代之的是神秘解析器(感谢astrojuanlu)
更新:现在sphinx文档正式支持并记录了这一点。
看起来它的基本实现已经进入了Sphinx,但还没有消息传出去。见github问题评论
安装的依赖关系:
pip install commonmark recommonmark
调整conf.py:
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
source_suffix = ['.rst', '.md']
有解决方法 sphinx-quickstart.py脚本生成一个Makefile。 每次您想要生成文档以将Markdown转换为reStructuredText时,都可以轻松地从Makefile调用Pandoc。
推荐文章
- 我如何创建一个文本框的笔记在markdown?
- Pandas:索引数据帧时的多个条件-意外行为
- 如何更改Django应用程序的名称?
- 如何在python抽象类中创建抽象属性?
- “克隆”行或列向量
- 在python shell中按方向键时看到转义字符
- 在pip install中方括号是什么意思?
- 使用Matplotlib以非阻塞的方式绘图
- 使用sklearn缩放Pandas数据框架列
- 如何创建关键或附加一个元素的关键?
- virtualenv的问题-无法激活
- 是否可以使用scikit-learn K-Means聚类来指定自己的距离函数?
- 如何在Python中删除文本文件的文件内容?
- 一个干净、轻量级的Python扭曲的替代品?
- 在Python中从字符串中移除所有非数字字符