简介
LaTeX 是当今世界上最流行和使用最为广泛的TeX 格式,可以在短短的时间内生成高质量的 pdf 文档。它构筑在 Plain TeX 的基础之上,并加进了很多的功能以使得使用者可以更为方便的利用 TeX 的强大功能。
使用 LaTeX,一般需要安装 TexLive,但TexLive 安装包太大,有好几 G,且每个环境安装方式不一样。为了减少安装成本以及方便的集成到 CI/CD 环境中,本文推荐使用 TinyTeX。TinyTeX 是一个瘦身版的TeX Live,安装后大概 100M 左右。TinyTeX 是国内大神谢益辉作品,请参考https://yihui.name/tinytex/cn/。
Sphinx 是一个自动文档生成工具,可以自动的把 docstring 转换为文档,并支持多种输出格式包括 html,pdf 等。
实现 Sphinx 自动生成 pdf 步骤
以下是 Ubuntu 实现步骤,其它系统读者可以自行实现,原理一样
安装 python3
sudo add-apt-repository ppa:jonathonf/python-3.6
sudo apt-get update
sudo apt-get install -y python3.6
安装 python 虚拟环境
sudo apt-get install -y python3-pip
sudo pip3 install virtualenv
virtualenv -p /usr/bin/python3.6 ~/virtualenvs/venv_devopspy
source ~/virtualenvs/venv_devopspy/bin/activate
安装 git(可选)
apt-get install -y git
git clone git@code.aliyun.com:payun/api-site.git
git checkout "sphinx 文档"
安装 sphinx 主题(可选)
pip3 install --index-url https://pypi.tuna.tsinghua.edu.cn/simple/ sphinx jieba
cd sphinx_payun_theme/
python setup.py install
cd ../
安装瘦身版 TinyteX(关键)
apt-get install -y libfontconfig
wget -qO- "https://yihui.name/gh/tinytex/tools/install-unx.sh" | sh
export PATH=$PATH:~/bin
tlmgr install cmap psnfss fncychap fancyhdr titlesec tabulary varwidth wrapfig parskip capt-of needspace cjk collection-fontsrecommended
编译
make clean
make html
make latexpdf
总结
将上诉步骤集成在流水线中,能一键生成精美 pdf 文档。经实测集成在阿里云流水线中,生成文档时间在3分钟内,提高了开发效率。
网友评论