使用myst_parser编译Sphinx文档时交叉引用警告的消除方案
Markdown格式化指南
以下是Markdown内容的格式化规则:
- 标题:使用井号(
#)设置标题层级,层级从#到######对应一级到六级标题,示例:# 一级标题 ## 二级标题 - 列表项:以短横线(
-)开头创建无序列表,支持嵌套,示例:- 外层列表项 - 嵌套列表项 - 文本强调:用星号(
*)包裹文本实现强调,单星号对应斜体,双星号对应粗体,示例:- 斜体:
*斜体文本*→ 斜体文本 - 粗体:
**粗体文本**→ 粗体文本
- 斜体:
- 代码/命令:用反引号(
`)包裹单行内容,多行代码用三个反引号(```)包裹并可指定语言,示例:- 单行:
pip install myst-parser - 多行:
def test_func(): return "test"
- 单行:
- 引用文本:用大于号(
>)开头创建引用,支持嵌套,示例:> 基础引用 >> 嵌套引用内容 - 链接:格式为
[链接显示文本](目标URL),示例:[myst_parser文档](https://myst-parser.readthedocs.io/) - 图片:格式为
,示例:
内容的提问来源于stack exchange,提问作者PiWi
相关产品推荐
相关产品推荐

