使用gitlab runner 进行CI（四）：使用Gitlab Page托管项目文档

目录

• 1.什么是Gitlab Pages

• 2.开启Gitlab Pages

• 3.基本过程

• 4.托管markdown文档

• 4.1 安装sphinx等依赖

• 4.2 配置项目的sphinx配置

• 4.3 编写项目文档

• 4.4 创建首页索引

• 4.5 配置gitlab-ci.yml

• 4.6 生成网页

• 4.7 配置DNS或者hosts文件

• 5.预览和调试

• 5.1 直接使用sphinx命令生成网页

• 5.2 VScode+sphinx插件预览

• 5.3 下载Gitlab生成的网页

• 总结

这段时间准备软考去了，也挺久没更新了，考完了（明年再战…），可以开始继续这个系列了。
前面1篇是代码检查方面，这一篇主要讲一下如何用Gitlab来托管我们的项目文档，我接触到的项目文档一般有下面几种方式：

• 放在wiki里面：这种方式有个缺点就是不方便分享文档，也不好把文档转成其他格式

• 以markdown的形式和项目放在一起：这种方式应该算是使用方式比较广的了，很多开源项目也是这种。如果只是这么放着，看文档其实不是很方便，缺乏文档之间的导航。

• 使用Read the Docs 托管文档
  本篇文章比较类似于第三种，就是用Gitlab Pages来实现类似Read the Docs的效果ÿ