Style Guide¶
Escape: thisisoneword
test1 | String | 这里是测试的第一行 |
test2 | int | 这里是测试的第二行 |
列表¶
- 使用*,-,+都可以。
- 可以自动编号的
- 功能
- 这是一个功能描述
- 注意事项
- 这是注意事项描述
姓名: | 这个是姓名字段 |
---|---|
年龄: | 这个是年龄字段 |
工作: | 这个是工作字段,用于描述工作 |
-a | 列出所有条目 |
-l | 列出详细信息 |
--color=auto | 美化输出 |
--version | 显示版本 |
段落块¶
这是一个段落,使用|开头就可
Sphinx provides a documentation generator that is best-in-class for software docs.
Sphinx documents are written in the reStructuredText markup language. reStructuredText is a powerful language primarily because the syntax can be extended.
块引用¶
- 块引用:
- 块引用是使用:结尾的。
- 可以花式设置的。
文档测试块¶
>>> 使用>>>tab开头即可。