Skip to main content
Ctrl+K
Sphinx文档管理 - Home
  • 1. 引言
    • 1.1. 文档与文档管理
    • 1.2. 文档在软件开发中的作用
    • 1.3. 软件技术文档代码化现象
    • 1.4. 文档代码化重塑软件开发
    • 1.5. 文档制作工具Sphinx简介
  • 2. 使用Sphinx进行文档组织
    • 2.1. 安装与使用Sphinx
    • 2.2. Sphinx配置
    • 2.3. Sphinx构建
    • 2.4. 编辑 reStructuredText
    • 2.5. Sphinx重要扩展介绍
    • 2.6. 常见问题集锦
    • 2.7. 第一个 Sphinx 项目
    • 2.8. 支持的语法比较
  • 3. reStructuredText 标识语法
    • 3.1. ReST 文档结构语法
    • 3.2. ReST 行内文本常用语法
    • 3.3. 列表表示语法
    • 3.4. 超链接Hyperlink Targets
    • 3.5. Rest文本块
    • 3.6. 特殊提示
    • 3.7. 代码高亮
    • 3.8. 添加图片
    • 3.9. 表格
    • 3.10. 使用数学表达式
  • 4. Sphinx中的角色与指令
    • 4.1. Sphinx中角色和指令语法
    • 4.2. 交叉引用
    • 4.3. 脚注 Footnotes
    • 4.4. 引文(文献引用)
    • 4.5. 术语引用
    • 4.6. Sphinx+reStructuredText:变量的使用
  • 5. MyST扩展
    • 5.1. 为什么使用 MyST
    • 5.2. 在Sphinx中使用 MyST
    • 5.3. MyST 中的指令与角色
    • 5.4. 可选的 MyST 扩展语法
    • 5.5. MyST 与 Sphinx
    • 5.6. MyST-NB
  • 6. Sphinx 扩展模块
    • 6.1. 数学表达式渲染方式
    • 6.2. 使用Graphviz绘图
    • 6.3. 使用PlantUML绘图
    • 6.4. autosectionlabel
    • 6.5. sphinx.ext.todo
    • 6.6. 下拉框插件 sphinx-togglebutton
    • 6.7. 选项卡插件 sphinx_tabs.tabs
  • 7. Sphinx常用相关工具
    • 7.1. sphinx-autobuild
    • 7.2. RST-to-MyST
    • 7.3. API手册制作指南
    • 7.4. Sphinx中的国际化
    • 7.5. Sphinx 生成 PDF
    • 7.6. Sphinx中功能的扩展开发
    • 7.7. Sphinx-Multiversion 使用教程
  • 8. 工具链与技术栈
    • 8.1. Linux Shell 文本处理工具
    • 8.2. 版本控制系统Git教程
    • 8.3. Sphinx 协作开发
    • 8.4. Make工具介绍
    • 8.5. 使用Pandoc进行文档转换
    • 8.6. 发布网站到GitHub
    • 8.7. 发布静态网站
    • 8.8. Sphinx 文档发布
  • 9. Sphinx Design扩展模块介绍
    • 9.1. 安装与配置
    • 9.2. 网格
    • 9.3. 卡片
    • 9.4. 可下拉选项卡
    • 9.5. 标签选项卡
    • 9.6. 徽章,按钮和图标
    • 9.7. 附加
    • 9.8. 样式
  • 10. Jupyter Book文档管理与构建
    • 10.1. Jupyter Book 使用教程
    • 10.2. Jupyter Book 使用与配置指南
    • 10.3. JupyterLab 概述
    • 10.4. 开始使用
    • 10.5. 配置项和目录
    • 10.6. 一些语法说明
  • 11. 使用Sphinx主题样式
    • 11.1. 内置主题
    • 11.2. 使用既定主题
    • 11.3. sphinx book theme 主题特用指令
    • 11.4. 用户自定义主题
  • 12. Sphinx文档管理与编辑实践
    • 12.1. Sphinx文档项目配置
    • 12.2. Sphinx文档修改要求
    • 12.3. RestructuredText 文档规范
  • 13. 附录
    • 13.1. 术语表
    • 13.2. Sphinx 开发环境配置
    • 13.3. 数学符号
    • 13.4. Web基础知识
    • 13.5. Reference

Reference

目录

  • 13.5.1. 编辑工具
  • 13.5.2. 参考内容
    • sphinx
    • reStructureText

13.5. Reference#

13.5.1. 编辑工具#

steenhulthin/reStructuredText_NPP notepad++插件

http://rst.ninjs.org/ 在线

13.5.2. 参考内容#

sphinx#

https://www.sphinx.org.cn/

https://www.sphinx-doc.org/en/master/

https://zh-sphinx-doc.readthedocs.io/en/latest/

reStructureText#

https://docutils.sourceforge.io/docs/user/rst/quickref.html

https://blog.csdn.net/liuskyter/article/details/86570790

上一页

13.4. Web基础知识

目录
  • 13.5.1. 编辑工具
  • 13.5.2. 参考内容
    • sphinx
    • reStructureText

作者: BU Kun

© Copyright Since 2023. BU Kun, OSGeo China Chapter.