我讨厌reST,但喜欢Sphinx。是否有一种方法,狮身人面像读取Markdown而不是reStructuredText?
当前回答
这里有一个新的选择。MyST为Markdown添加了一些功能,允许Sphinx像rst一样构建文档。 https://myst-parser.readthedocs.io/en/latest/
其他回答
2021年5月更新:推荐标记已弃用,取而代之的是神秘解析器(感谢astrojuanlu)
更新:现在sphinx文档正式支持并记录了这一点。
看起来它的基本实现已经进入了Sphinx,但还没有消息传出去。见github问题评论
安装的依赖关系:
pip install commonmark recommonmark
调整conf.py:
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
source_suffix = ['.rst', '.md']
我推荐使用MyST Markdown。这是Markdown的一种风格,旨在引入reStructuredText的主要特性。MyST代表显著结构化文本,可以被认为是“带有Markdown的rST”。
MyST是CommonMark标准的超集,它被定义为通过markdown-it-py包对CommonMark进行的离散扩展的集合)。这意味着CommonMark语法可以与MyST一起开箱即用,但是如果您愿意,您也可以使用更多的语法特性。
MyST为reStructuredText中的几乎每个特性都提供了语法,并且针对完整的Sphinx测试套件进行了测试,以确保可以重新创建相同的功能。例如:
下面是如何在MyST中编写指令:
```{directivename} directive options
:key: value
:key2: value2
Directive content
```
这是你在《神秘岛》中如何编写角色的方法
Here's some text and a {rolename}`role content`
MyST Markdown的Sphinx解析器也有一些很好的Sphinx特有的特性,比如使用Markdown链接语法([some text](someelink))来处理Sphinx中的交叉引用。例如,你可以在MyST中定义一个标签,并引用它,像这样:
(my-label)=
# My header
Some text and a [cross reference](my-label).
对于一个更完整的MyST Markdown语法列表,一个很好的参考是Jupyter Book备考表,它有许多常见的文档需求和各自的MyST语法来完成它。(MyST是作为Jupyter Book的一个组件创建的,尽管从技术角度来看它是一个完全独立的项目)。
在Sphinx文档和ReadTheDocs文档中,MyST现在是Sphinx推荐的Markdown工具。
要将MyST解析器添加到Sphinx文档中,只需执行以下操作:
pip install myst-parser
在conf.py中添加:
extensions = [
...
"myst_parser",
...
]
您的Sphinx文档现在将能够解析CommonMark markdown以及扩展的MyST markdown语法!请查看MyST文档以获取更多信息!
我希望这有助于澄清一些事情!
请注意,使用maven和嵌入式Sphinx + MarkDown支持构建文档完全由以下maven插件支持:
https://trustin.github.io/sphinx-maven-plugin/index.html
<plugin>
<groupId>kr.motd.maven</groupId>
<artifactId>sphinx-maven-plugin</artifactId>
<version>1.6.1</version>
<configuration>
<outputDirectory>${project.build.directory}/docs</outputDirectory>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
</plugin>
这是对推荐方法的更新。
pip install recommonmark
我个人使用Sphinx 3.5.1,所以
# for Sphinx-1.4 or newer
extensions = ['recommonmark']
点击这里查看官方文件。
我采纳了Beni的建议,使用pandoc来完成这项任务。安装后,下面的脚本将把源目录中的所有markdown文件转换为rst文件,这样您就可以用markdown编写所有文档。希望这对其他人有用。
#!/usr/bin/env python
import os
import subprocess
DOCUMENTATION_SOURCE_DIR = 'documentation/source/'
SOURCE_EXTENSION = '.md'
OUTPUT_EXTENSION = '.rst'
for _, __, filenames in os.walk(DOCUMENTATION_SOURCE_DIR):
for filename in filenames:
if filename.endswith('.md'):
filename_stem = filename.split('.')[0]
source_file = DOCUMENTATION_SOURCE_DIR + filename_stem + SOURCE_EXTENSION
output_file = DOCUMENTATION_SOURCE_DIR + filename_stem + OUTPUT_EXTENSION
command = 'pandoc -s {0} -o {1}'.format(source_file, output_file)
print(command)
subprocess.call(command.split(' '))
推荐文章
- 有没有办法在python中做HTTP PUT
- “foo Is None”和“foo == None”之间有什么区别吗?
- 类没有对象成员
- Django模型“没有显式声明app_label”
- 熊猫能自动从CSV文件中读取日期吗?
- 在python中zip的逆函数是什么?
- 有效的方法应用多个过滤器的熊猫数据框架或系列
- 如何检索插入id后插入行在SQLite使用Python?
- 我如何在Django中添加一个CharField占位符?
- 如何在Python中获取当前执行文件的路径?
- 我如何得到“id”后插入到MySQL数据库与Python?
- super()失败,错误:TypeError "参数1必须是类型,而不是classobj"当父不继承对象
- Python内存泄漏
- 实现嵌套字典的最佳方法是什么?
- 如何在tensorflow中获得当前可用的gpu ?