A Brief Tutorial On Sphinx and reStructuredText Logo
0.1
  • 1. 引言
  • 2. 基础教程
  • 3. 进阶指南
    • 3.1. 简介
    • 3.2. API手册制作指南
    • 3.3. 项目文档制作指南
    • 3.4. 发布网站到GitHub
  • 4. 名词术语
A Brief Tutorial On Sphinx and reStructuredText
  • Docs »
  • 3. 进阶指南
  • View page source

3. 进阶指南¶

  • 3.1. 简介
  • 3.2. API手册制作指南
    • 3.2.1. 一个例子
      • 3.2.1.1. 撰写代码和文档
      • 3.2.1.2. 初始化Sphinx工程
      • 3.2.1.3. 配置Sphinx工程
      • 3.2.1.4. 生成API注释文档
      • 3.2.1.5. 编译生成API手册
    • 3.2.2. 文档注释风格支持
    • 3.2.3. 问题解决
      • 3.2.3.1. 生成的文档无注释
      • 3.2.3.2. 注释中不显示公式
  • 3.3. 项目文档制作指南
  • 3.4. 发布网站到GitHub
    • 3.4.1. 什么是 GitHub Pages
    • 3.4.2. 为你的工程库制作网站
Next Previous

© Copyright 2015-2018,刘志,西安电子科技大学,智能感知与图像理解教育部重点实验室

Built with Sphinx using a theme provided by Read the Docs.