logo

Sphinx文档写作管理
  • 1. 使用Sphinx进行文档组织
    • 1.1. 文档制作简介
    • 1.2. 安装与使用Sphinx
    • 1.3. sphinx配置
    • 1.4. 编辑 reStructuredText
    • 1.5. Sphinx重要扩展介绍
    • 1.6. 常见问题集锦
  • 2. reStructuredText 标识语法
    • 2.1. ReST 文档结构语法
    • 2.2. ReST 行内文本常用语法
    • 2.3. 列表表示语法
    • 2.4. 超链接Hyperlink Targets
    • 2.5. Rest文本块
    • 2.6. 特殊提示
    • 2.7. 代码高亮
    • 2.8. 添加图片
    • 2.9. 表格
    • 2.10. 使用数学公式
  • 3. Sphinx中的角色与指令
    • 3.1. rst的角色和指令
    • 3.2. 交叉引用
    • 3.3. 脚注 Footnotes
    • 3.4. 引文（文献引用）
    • 3.5. 术语引用
  • 4. Sphixn进阶及常用扩展模块
    • 4.1. 数学公式渲染方式
    • 4.2. 在Sphinx中支持Markdown
    • 4.3. 使用graphviz绘图
    • 4.4. 使用PlantUML绘图
    • 4.5. API手册制作指南
    • 4.6. Sphinx中的国际化
    • 4.7. Sphinx 生成 PDF
    • 4.8. Sphinx中功能的扩展开发
  • 5. 工具链与技术栈
    • 5.1. Linux Shell 文本处理工具
    • 5.2. 版本控制系统Git教程
    • 5.3. Make工具介绍
    • 5.4. 使用Pandoc进行文档转换
    • 5.5. 发布网站到GitHub
    • 5.6. 发布静态网站
  • 6. Sphinx文档管理与编辑实践
    • 6.1. Sphinx文档项目配置
    • 6.2. Sphinx文档修改要求
    • 6.3. RestructuredText 文档规范
  • 7. 附录
    • 7.1. 术语表
    • 7.2. Reference
Theme by the Executable Book Project

Sphinx中的角色与指令¶

与其他工具相比，Sphinx 使用的 RestructuredText 允许更高程度的自定义。 在Sphinx中称为 角色（role）与指令（directive）。

本教程将说明如何自定义Sphinx以适合您的工作流程。

  • rst的角色和指令
    • 角色
    • 指令
    • 元信息标记
  • Sphinx中的常用角色
  • 特殊提示
  • 代码高亮
    • 快速定义代码块
    • code-block代码高亮
    • literalinclude直接嵌入本地文件并高亮
  • 渲染数学公式
    • 添加插件
    • 行内公式
    • Sphinx 常见问题及解决方式
    • 如何使用原始的 html 标签
    • 如何支持中文搜索
    • Sphinx数学支持
    • 使用LaTex渲染公式
    • 使用KaTex渲染公式
    • 使用MathJax渲染公式
  • 数学公式

By GISLite
© Copyright Since 2023. GisLite, OSGeo China Chapter.