如何在Sphinx中禁用类描述里的__init__参数重复文档
Markdown格式使用指南
1. 标题
通过#的数量区分层级,最多支持6级:
# 一级标题 ## 二级标题 ### 三级标题
渲染效果:
一级标题
二级标题
三级标题
2. 无序列表
以-开头创建列表,嵌套时缩进2个空格:
- 第一项内容 - 第二项内容 - 嵌套子项1 - 嵌套子项2
渲染效果:
- 第一项内容
- 第二项内容
- 嵌套子项1
- 嵌套子项2
3. 文本强调
- 斜体:用单个
*包裹文本 → 这是斜体强调文本 - 粗体:用两个
*包裹文本 → 这是粗体强调文本
4. 代码/命令
用反引号`包裹单行代码或命令:
安装Sphinx:`pip install sphinx==8.2.3` Python代码示例:`print("Hello, Sphinx!")`
渲染效果:
安装Sphinx:pip install sphinx==8.2.3
Python代码示例:print("Hello, Sphinx!")
5. 引用文本
用>开头创建引用块,支持多行连续引用:
> 工欲善其事,必先利其器。 > ——《论语·卫灵公》
渲染效果:
工欲善其事,必先利其器。
——《论语·卫灵公》
6. 链接
格式为[显示文本](目标URL):
[Sphinx官方文档](https://www.sphinx-doc.org/)
渲染效果:
Sphinx官方文档
7. 图片
格式为[图片替代文本](图片URL),替代文本用于图片加载失败时的提示:
[Sphinx Logo](https://www.sphinx-doc.org/en/master/_static/sphinx-logo.svg)
渲染效果:
Sphinx Logo
内容的提问来源于stack exchange,提问作者Paebbels
相关产品推荐
相关产品推荐

