Sphinx documentation on gitlab pages

See also

Continuous deployment of the documentation

See also

To produce your sphinx documentation, simply put this .gitlab-ci.yml file at the root of your documentation.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
image: python:3.8-slim

pages:
  script:
  - pip install -r requirements.txt
  - sphinx-build -d _build/doctrees . _build/html
  - mv _build/html public
  artifacts:
    paths:
    - public
  only:
  - master

If you use pipenv for your sphinx documentation, produce the requirements.txt file with this command:

pipenv lock -r > requirements.txt

total 200
 4 drwxr-xr-x 10 pvergain doc  4096 mai   21 12:53 ./
 4 drwxrwxr-x 14 pvergain doc  4096 mai   20 19:41 ../
 4 drwxr-xr-x  4 pvergain doc  4096 mai   21 11:31 _build/
68 -rw-r--r--  1 pvergain doc 66507 mai   16 22:28 charac-more.png
 4 drwxr-xr-x  7 pvergain doc  4096 mai   16 22:28 cli/
 8 -rw-r--r--  1 pvergain doc  5786 mai   21 11:23 conf.py
 4 drwxr-xr-x  4 pvergain doc  4096 mai   16 22:28 devel/
 4 drwxr-xr-x 12 pvergain doc  4096 mai   21 11:29 documentation/
 4 drwxr-xr-x  8 pvergain doc  4096 mai   21 14:31 .git/
 4 -rw-r--r--  1 pvergain doc   140 mai   20 18:40 .gitignore
 4 -rw-r--r--  1 pvergain doc   212 mai   16 22:28 .gitlab-ci.yml
 4 -rw-r--r--  1 pvergain doc   920 mai   21 12:53 index.rst
 4 -rw-r--r--  1 pvergain doc   651 mai   16 22:28 Makefile
16 -rw-r--r--  1 pvergain doc 15811 mai   21 14:31 objects.inv
 4 -rw-r--r--  1 pvergain doc   158 mai   16 22:28 Pipfile
 8 -rw-r--r--  1 pvergain doc  6388 mai   21 11:12 Pipfile.lock
 4 -rw-r--r--  1 pvergain doc   327 mai   21 12:26 README.md
 4 -rw-r--r--  1 pvergain doc   344 mai   20 18:39 requirements.txt
32 -rw-r--r--  1 pvergain doc 29330 mai   16 22:28 small-globe.png
 4 drwxr-xr-x  2 pvergain doc  4096 mai   16 22:28 _static/
 4 drwxr-xr-x  4 pvergain doc  4096 mai   16 22:28 _themes/
 4 drwxr-xr-x  4 pvergain doc  4096 mai   16 22:29 .venv/