使用 Sphinx 製作文件

安裝 Sphinx

  $ pip install sphinx

指定專案名稱、作者、版本，使用 EPUB 來建立文件專案

  $ sphinx-quickstart -q -p example -a author -v 1.0.0 --epub docs

或以互動的方式，回答問題來建立

  $ sphinx-quickstart docs

建完會產生一個專案目錄

  $ tree docs
  docs
  ├── Makefile
  ├── _build
  ├── _static
  ├── _templates
  ├── conf.py
  ├── index.rst
  └── make.bat

  3 directories, 4 files

直接編輯 index.rst 就可以開始撰寫文件了，語法可以參考 A ReStructuredText Primer

執行

  $ make html
  $ make singlehtml
  $ make epub
  $ make latexpdf

分別匯出 HTML、EPUB 和 PDF 在 _build 目錄底下，匯出 PDF 要先安裝 MacTeX

參考

• Sphinx
• A ReStructuredText Primer