fabric应用-ca官方文档编译及发布

官方发布的 CA文档 非常陈旧，但是CA文档源的内容却一直在更新，为了能即时了解最新的文档动向，还是需要自己根据官方提供的文档源码，编译一份可阅读的文档。
但官方文档使用的是sphinx生成的，而按照官方提供的方式，无法直接编译，为此本文记录一下实际编译流程。

简介

为了避免污染主机环境，本文将使用docker编译官方的CA文档源码。

下载脚本

git clone https://github.com/bitxx/docker_bash.git
cd docker_bash

我将常用的一些docker镜像都集成到上面的脚本中了，下载后，有兴趣可以看看，在这里主要就是关注python在docker-compose.yml中的编排

启动python容器

./main.sh start python

该操作可以通过docker-compose将python容器启动

编译文档

1. 将ca文档源码根目录docs中的所有内容，直接拷贝到上述python容器映射的主机目录$ROOT_PATH/data-server/${CONTAINER_PYTHON}/data/下
2. 进入容器，并进入指定映射目录

./main.sh exec python 
cd /docs

3. 虽然ca文档源码中官方提供了requirements.txt，但是你会发现如果直接使用，不管用哪个版本的python，都无法成功编译，因此需要手动执行加入以下依赖包，默认使用最新版的包：

pip install sphinx
pip install sphinx_rtd_theme
pip install recommonmark

4. 编译生成html文档

make html

build/html/中会有编译后的文档，这就是最终完整的编译内容，之后只要用nginx等服务器部署该静态文档即可。

停止sphinx容器

./main.sh release python

总结

本文主要记录了编译官方CA文档源码的流程，方便后续参考。

Donate