Test Builds¶
This repository is used internally to create different scenarios on build configs and trigger many builds on Read the Docs productions.
Each branch should explain on it’s docs/index.rst
what’s about and how the
QA process can be considered a success or a failure.
If we need to test a very specific use case, we create a new branch with
the issue number and the repository, like: issue-1234-org
, issue-4321-ext
or similar.
Scenarios¶
Each of these scenarios is a branch that can be built independently from the others.
Please, check all the branches and all the tags to be sure.
Adding a new scenario to the repository¶
Create a new branch from
master
using an appropiate nameExplain what’s the use case in its
docs/index.rst
fileHow to check if the QA can be considered success or failure
Add links to the issue tracker where there are more information
Add or modify the necessary files
Make sure that these files contains the minimum configuration needed:
remove auto generated comments
configs not used
Push your changes
Sphinx configuration file used to build this docs (see full file),
1# Default settings
2project = 'Test Builds'
3extensions = [
4 'sphinx_autorun',
5]
6
7html_static_path = ['_static']
8
9html_js_files = ['test.js']
10
11latex_engine = 'xelatex' # allow us to build Unicode chars
12root_doc = 'index'
13
14
15# Include all your settings here
16html_theme = 'sphinx_rtd_theme'
17
18
19
20
>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow() # UTC
datetime.datetime(2022, 5, 17, 16, 35, 30, 655108)

WOW¶