.rst .pdf

4. 工具链与技术栈

Sphinx 本身只是文档发布工具，但现在应用范围也很广。 维护这个工具目前也产生了一系列的技术生态。 充分使用这些技术工具，会大大减少工作量；或者让产出的效益增强。

• 4.1. Linux Shell 文本处理工具
  • 4.1.1. find 文件查找
  • 4.1.2. grep 文本搜索
  • 4.1.3. 用 tr 进行转换
  • 4.1.4. sed 文本替换利器
• 4.2. 版本控制系统Git教程
  • 4.2.1. What is Git?
  • 4.2.2. Why Git?
  • 4.2.3. How to
  • 4.2.4. Git命令概览
  • 4.2.5. 子模块
  • 4.2.6. 搭建Git服务器
  • 4.2.7. 简化命令
  • 4.2.8. 错误解决
• 4.3. Make工具介绍
  • 4.3.1. Make程序的命令行选项和参数
  • 4.3.2. Makefile概述
• 4.4. Sphinx中的国际化
  • 4.4.1. Sphinx internationalization details
  • 4.4.2. Translating with sphinx-intl
  • 4.4.3. 编译
  • 4.4.4. 示例
• 4.5. MyST
  • 4.5.1. MyST
  • 4.5.2. MyST-Parser
• 4.6. 在Sphinx中使用graphviz来画图
  • 4.6.1. 安装graphviz
  • 4.6.2. 修改项目配置文件
  • 4.6.3. 画图
• 4.7. PlantUML for Sphinx
  • 4.7.1. Installation
  • 4.7.2. Usage
  • 4.7.3. Configuration
• 4.8. API手册制作指南
  • 4.8.1. 一个例子
  • 4.8.2. 文档注释风格支持
  • 4.8.3. 问题解决
• 4.9. Sphinx 生成 PDF
  • 4.9.1. 个人心得
  • 4.9.2. Sphinx 语法高亮支持的关键字
  • 4.9.3. Sphinx 部署
• 4.10. 发布网站到GitHub
  • 4.10.1. 什么是 GitHub Pages
  • 4.10.2. 为你的工程库制作网站
• 4.11. 发布静态网站
  • 4.11.1. 使用Apache建立自己的网站服务器
• 4.12. 问题集锦
  • 4.12.1. 源编码
  • 4.12.2. 中文文档问题
  • 4.12.3. 中文分词问题
  • 4.12.4. 中文乱码问题

previous

3.8. Sphinx中功能的扩展开发

next

4.1. Linux Shell 文本处理工具