biggates/docker-sphinx-latex-cn repository overview

build/
sphinx/
├─source/
|   ├─conf.py
|   ├─index.rst
|   ├─_static/
|   └─_templates/
├─.git/
├─make.bat
└─Makefile

$ chmod -R +rw build

$ rm -rf build/**

$ docker run --rm -v "$(pwd)":/home/python/doc -v "$(pwd)/build":/home/python/build biggates/docker-sphinx-latex-cn:builder make html

$ docker run --rm -v "$(pwd)":/home/python/doc -v "$(pwd)/build":/home/python/build biggates/docker-sphinx-latex-cn:latex-builder make latexpdf

pipeline {
    // 在前面的 stage 里面检出项目，并处理 `docs` 目录中含有 sphinx 相关的内容
	stage('Sphinx build') {
		agent {
			docker {
                // reuseNode 是为了直接利用之前检出好的项目
				reuseNode true
				image 'biggates/docker-sphinx-latex-cn:builder'

                // jenkins 会强制用 root 用户登录，因此手动再设置一次 PATH 否则找不到 sphinx
				args "-e PATH=/home/python/.venv/bin:/usr/local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
			}
		}
		steps {
            // 安装项目中的 requirements，大部分常用项目已安装所以这里会比较快
            sh "pip install -r requirements.txt"

            // 如果使用 autodoc 组件，则还需要手动将当前目录安装到 pip
            sh "pip install -e ."

			dir ('./docs') {
				sh "make html"
			}
		}
	}
}

$ docker build -t docker-sphinx-latex-cn:base -f base/Dockerfile .
$ docker build -t docker-sphinx-latex-cn:builder -f builder/Dockerfile .
$ docker build -t docker-sphinx-latex-cn:latex-base -f latex-base/Dockerfile .
$ docker build -t docker-sphinx-latex-cn:latex-builder -f latex-builder/Dockerfile .
$ docker build -t docker-sphinx-latex-cn:scipy-builder -f scipy-builder/Dockerfile .