降价

Markdown __是一种轻量级标记语言,具有简单的纯文本格式化语法。它存在于许多句法上不同的地方 flavors 。为了支持基于Markdown的文档,Sphinx可以使用 `MyST-Parser`__. Myst-Parser是Docutils连接到 `markdown-it-py`__, a Python package for parsing the `CommonMark`__ 降价口味。

配置

要配置您的Sphinx项目以获得降价支持,请执行以下操作:

  1. 安装Markdown解析器 MyST-Parser **

    pip install --upgrade myst-parser
    
  2. 增列 myst_parser 发送到 list of configured extensions **

    extensions = ['myst_parser']
    

    备注

    Myst-Parser需要Sphinx 2.1或更高版本。

  3. 如果要使用扩展名不是的Markdown文件 .md ,调整 source_suffix 变量。以下示例将Sphinx配置为解析具有扩展名的所有文件 .md.txt 作为降价::

    source_suffix = {
        '.rst': 'restructuredtext',
        '.txt': 'markdown',
        '.md': 'markdown',
    }
    
  4. 您可以进一步配置 MyST-Parser 允许使用标准的自定义语法 CommonMark 不支持。阅读更多内容请参阅 `MyST-Parser documentation`__.