[野火]sphinx文档规范与模版
stable

为什么使用sphinx写文档

  • 关于本项目
  • 关于野火
  • 快速参与本项目(提交bug或文档修改)
  • TODO和悬赏任务

使用sphinx和vscode编写文档

  • 1. sphinx的安装与使用
  • 2. 使用vscode编写rst文件

reST语法

  • 1. 基础语法
  • 2. 超链接与文件引用
  • 3. 代码高亮
  • 4. 图片与视频
  • 5. 特殊提示
  • 6. rst的指令和角色(directive and role)
  • 7. 野火sphinx文档规范

使用markdown

  • 使sphinx支持markdown

文档格式转换

  • 使用pandoc进行文档转换

常见问题

  • 常见问题

版权

  • 版权说明
[野火]sphinx文档规范与模版
  • Docs »
  • [野火]sphinx文档规范与模版
  • Edit on GitHub

[野火]sphinx文档规范与模版¶

为什么使用sphinx写文档

  • 关于本项目
  • 关于野火
  • 快速参与本项目(提交bug或文档修改)
  • TODO和悬赏任务

使用sphinx和vscode编写文档

  • 1. sphinx的安装与使用
  • 2. 使用vscode编写rst文件

reST语法

  • 1. 基础语法
  • 2. 超链接与文件引用
  • 3. 代码高亮
  • 4. 图片与视频
  • 5. 特殊提示
  • 6. rst的指令和角色(directive and role)
  • 7. 野火sphinx文档规范

使用markdown

  • 使sphinx支持markdown

文档格式转换

  • 使用pandoc进行文档转换

常见问题

  • 常见问题

版权

  • 版权说明
Next

© Copyright 2019, embedfire-野火 www.embedfir.com Revision 97670538.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: stable
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.