Build with build.jobs
This version is built with build.jobs
.
It only builds when the docs
dir has changed.
Note
The following text should be something different than { VERSION }
: {VERSION}
We are using sed
to replace the version with the value of READTHEDOCS_VERSION_NAME
.
1version: 2
2
3build:
4 os: ubuntu-20.04
5 jobs:
6 post_checkout:
7 - echo `date`
8 # Exit when there aren't changed in docs directory
9 # --quiet exits with a 1 when there **are** changes,
10 # so we invert the logic with a !
11 - "! git diff --quiet origin/main -- docs"
12 tools:
13 python: "3"
14
15sphinx:
16 configuration: docs/conf.py
17
18python:
19 install:
20 - requirements: requirements.txt
Sphinx configuration file used to build this docs (see full file),
1# -*- coding: utf-8 -*-
2
3# Default settings
4project = 'Test Builds'
5extensions = [
6 'sphinx_autorun',
7]
8
9latex_engine = 'xelatex' # allow us to build Unicode chars
10
11
12# Include all your settings here
13html_theme = 'sphinx_rtd_theme'
14
15
16
17
>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow() # UTC
datetime.datetime(2022, 10, 7, 21, 15, 6, 340576)