使用 Sphinx 撰寫技術文檔並生成 PDF 總結

這幾天準備編排部分翻譯的書籍和文檔，找了好些工具，最終定格在 Sphinx 上，並基於 ReadTheDocs 提供的 SaaS 服務進行分發和分享。本篇博客是對整個過程的一次記錄和總結。

項目代碼：qiwihui/sphinx-doc-starter

認識 Sphinx

Sphinx 是一個基於 Python 的文檔生成項目。最先只是用來生成 Python 的項目文檔，使用 reStructuredText 格式。但隨着項目的逐漸完善，不少非 Python 的項目也採用 Sphinx 做爲文檔寫做工具，甚至徹底能夠用 Sphinx 來寫書。

使用 Sphinx 生成文檔的優勢包括：

• 豐富的輸出格式: 支持輸出爲 HTML（包括 Windows 幫助文檔），LaTeX（能夠打印PDF版本）, manual pages（man 文檔）, 純文本等若干種格式；
• 完備的交叉引用: 語義化的標籤，並能夠自動化連接函數、類、引文、術語等；
• 明晰的分層結構: 輕鬆定義文檔樹，並自動化連接同級/父級/下級文章；
• 美觀的自動索引: 可自動生成美觀的模塊索引；
• 精確的語法高亮: 基於 Pygments 自動生成語法高亮；
• 開放的擴展: 支持代碼塊的自動測試，自動包含 Python 的模塊自述文檔，等等。

開始

這個過程包括以下步驟：

• 安裝 Sphinx
• 第一個文檔
• 在線託管
• 生成 PDF

安裝 Sphinx

Sphinx 依賴於 Python，並提供了 Python 包，因此使用 pip 安裝既可。這裏我只安裝了 sphinx-doc 這個包。

pip install sphinx-doc

這時，經過 bash 自動補全（連續兩下 tab），能夠看到有幾個命令，Sphinx 推薦使用 sphinx-quickstart，這是一個設置嚮導。

$ sphinx-
sphinx-apidoc      sphinx-autogen     sphinx-build       sphinx-quickstart

設置 Sphinx

運行 sphinx-quickstart，如下主要設置項目名稱，做者名稱以及語言（zh_CN）便可，其餘默認。

$ sphinx-quickstart
Welcome to the Sphinx 1.8.4 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Selected root path: .

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]: y

Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]: 

The project name will occur in several places in the built documentation.
> Project name: 一本書
> Author name(s): qiwihui
> Project release []: 0.0.1

If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.

For a list of supported codes, see
http://sphinx-doc.org/config.html#confval-language.
> Project language [en]: zh_CN

The file name suffix for source files. Commonly, this is either ".txt"
or ".rst".  Only files with this suffix are considered documents.
> Source file suffix [.rst]: 

One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]: 
Indicate which of the following Sphinx extensions should be enabled:
> autodoc: automatically insert docstrings from modules (y/n) [n]: 
> doctest: automatically test code snippets in doctest blocks (y/n) [n]: 
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]: 
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]: 
> coverage: checks for documentation coverage (y/n) [n]: 
> imgmath: include math, rendered as PNG or SVG images (y/n) [n]: 
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]: 
> ifconfig: conditional inclusion of content based on config values (y/n) [n]: 
> viewcode: include links to the source code of documented Python objects (y/n) [n]: 
> githubpages: create .nojekyll file to publish the document on GitHub pages (y/n) [n]: 

A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html` instead of invoking sphinx-build
directly.
> Create Makefile? (y/n) [y]: 
> Create Windows command file? (y/n) [y]: 

Creating file ./source/conf.py.
Creating file ./source/index.rst.
Creating file ./Makefile.
Creating file ./make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file ./source/index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
   make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

解釋1，整個設置過程包括：

1. 是否分離源文件目錄 source 和生成文件目錄 build，默認否；
2. 模板目錄 templates 和靜態文件目錄 static 前綴，默認爲_；
3. 項目名稱；
4. 項目做者；
5. 項目版本，默認爲空；
6. 項目語言，默認爲 en；
7. 文檔擴展名，默認爲 .rst；
8. 首頁文件名，默認爲 index；

9. 開啓的擴展，均默認爲否：

   • autodoc
   • doctest
   • intersphinx
   • todo
   • coverage
   • imgmath
   • mathjax
   • ifconfig
   • viewcode
   • githubpages
10. 生成 Makefile，默認是；
11. 生成 Windows 用命令行，默認是。

解釋2，項目目錄文件結構以下：

sphinx-test
├── Makefile
├── build
├── make.bat
└── source
    ├── _static
    ├── _templates
    ├── conf.py
    └── index.rst

其中：

• Makefile：能夠看做是一個包含指令的文件，在使用 make 命令時，可使用這些指令來構建文檔輸出。
• build：生成的文件的輸出目錄。
• make.bat：Windows 用命令行。
• _static：靜態文件目錄，好比圖片等。
• _templates：模板目錄。
• conf.py：存放 Sphinx 的配置，包括在 sphinx-quickstart 時選中的那些值，能夠自行定義其餘的值。
• index.rst：文檔項目起始文件。

接下來看看默認生成的內容：

$ make html
Running Sphinx v1.8.4
loading translations [zh_CN]... done
making output directory...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index                                                                                                         looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                                                          generating indices... genindex
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in Chinese (code: zh) ... done
dumping object inventory... done
build succeeded.

The HTML pages are in build/html.

而後直接在瀏覽器中打開 build/html/index.html 這個文件。

默認風格爲 alabaster，能夠改爲 ReadTheDocs 的風格： sphinx_rtd_theme。

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'

第一個文檔

咱們以一下文檔爲例：

This is a Title
===============
That has a paragraph about a main subject and is set when the '='
is at least the same length of the title itself.

Subject Subtitle
----------------
Subtitles are set with '-' and are required to have the same length
of the subtitle itself, just like titles.

Lists can be unnumbered like:

 * Item Foo
 * Item Bar

Or automatically numbered:

 #. Item 1
 #. Item 2

Inline Markup
-------------
Words can have *emphasis in italics* or be **bold** and you can define
code samples with back quotes, like when you talk about a command: ``sudo``
gives you super user powers!

將之寫入 example.rst 中，並修改 index.rst 爲:

Welcome to 一本書's documentation!
==================================

.. toctree::
   :maxdepth: 2
   :caption: 目錄:

   example

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

從新編譯，這時文檔已經改變。

在線託管

ReadTheDocs 但是直接用於託管 sphinx 生成的網頁文檔。
將以前的文檔用 Git 管理，並推送到 Github，而後在 ReadTheDocs 中 Import a Project 便可。

另外，能夠設置自定義域名：

1. 在域名管理中添加 DNS 的 CNAME 記錄到 readthedocs.io，好比 onebook.qiwihui.com
2. 在項目的 Admin -> Domains 中設置上一步添加的域名，開啓 HTTPS，保存便可。

過程很簡單。

生成 PDF

Sphinx 生成 PDF 的過程先將 rst 轉換爲 tex，再生產PDF。這個過程遇到了比較多的坑，最後總結下來過程以下：

首先，安裝 Tex 環境。在 Mac 上，推薦安裝 MacTex 而不是 BasicTex，對於新手來講 BasicTex 上須要本身處理不少以來問題。完成後使用 tlmgr 更新 TexLive。

$ brew cask install mactex
$ sudo tlmgr update --self

而後，在 con.py 中設置 latex_engine 和 latex_elements 兩個參數，同時也能夠設置 latex_documents 參數來設置文檔。

latex_engine = 'xelatex'
latex_elements = {
    'papersize': 'a4paper',
    'pointsize': '11pt',
    'preamble': r'''
\usepackage{xeCJK}
\setCJKmainfont[BoldFont=STZhongsong, ItalicFont=STKaiti]{STSong}
\setCJKsansfont[BoldFont=STHeiti]{STXihei}
\setCJKmonofont{STFangsong}
\XeTeXlinebreaklocale "zh"
\XeTeXlinebreakskip = 0pt plus 1pt
\parindent 2em
\definecolor{VerbatimColor}{rgb}{0.95,0.95,0.95}
\setcounter{tocdepth}{3}
\renewcommand\familydefault{\ttdefault}
\renewcommand\CJKfamilydefault{\CJKrmdefault}
'''
}
# 設置文檔
latex_documents = [
    (master_doc, 'sphinx.tex', '你的第一本 Sphinx 書',
     '做者：qiwihui', 'manual', True),
]

最後，編譯：

$ make latexpdf

make latexpdf 會完成 rst轉換爲 tex 並將 tex 生成 PDF，能夠手動分開：

$ make latex
$ cd build/latex
$ make

在 build/latex 下能夠查看到生成的 PDF 文檔。

字體

使用 fc-list 來獲取字體信息，修改相應字體設置便可。

$ brew install fontconfig
$ fc-list :lang=zh

遇到的問題:

1. 遇到 "! LaTeX Error: File '*.sty' not found." 類的問題：

解決：使用 sudo tlmgr install 安裝相應的包便可。

總結

簡單過了一下整個文檔的流程，整體來講，Sphinx很是適合用來編寫項目文檔，reStructuredText 比起 Markdown 也有太多的優點，值得推薦。

GitHub repo: qiwihui/blog

Follow me: @qiwihui

Site: QIWIHUI