Sphinx + reStructuredText 筆記


因為接下了一個案子,所要編寫文檔,所以就出現了這篇簡單的記錄

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# 先建立虛擬環境
cd ~/Venv
virtualenv --no-site-package sphinx
source ~/Venv/sphinx/bin/activate

# 之後應該會進入了這個環境後進行安裝
pip install Sphinx

# 為了防止出現 raise default locale 的錯誤,加入環境變量
export LC_ALL=en_US.UTF-8

# 之後再來建立一個 Project
cd ~/Desktop
mkdir mydoc
cd mydoc
sphinx-quickstart

# 之後跟著指示進行設置
# 至於插件方面如不知道就答否吧

# 建立 HTML 頁面
make html

# 生成 PDF 方面就需要安裝,再重開?
MacTeX.mpkg.zip

# 之後再修改 config.py 中對應的參數為以下內容
latex_preamble = '''\usepackage{CJKutf8}\n\AtBeginDocument{\\begin{CJK}{UTF8}{bsmi}}\n\AtEndDocument{\end{CJK}}'''

# 並註解掉 language 選項
language = '' -> #language = ''

# 生成 PDF
make latexpdf