test-builds

GitHub repository to test different Read the Docs builds scenarios.

Read the Docs configuration file used to build this docs:

 1version: 2
 2
 3formats:
 4  - pdf
 5
 6build:
 7  os: ubuntu-22.04
 8  tools:
 9    python: "3"
10  apt_packages:
11    - tree
12
13sphinx:
14  configuration: docs/conf.py
15
16python:
17  install:
18    - 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# Fail the PDF build on purpose by producing a syntax error
17#
18# ! Undefined control sequence.
19# l.71 \useage
20#             [titles]{}
21
22# ! LaTeX Error: Missing \begin{document}.
23latex_elements = {
24    'preamble': r'''
25\useage[titles]{}
26''',
27}
28
29
30
31

>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow()  # UTC
datetime.datetime(2023, 3, 6, 19, 17, 57, 307008)