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-4321-ext or similar.
Each of these scenarios is a branch that can be built independently from the others.
Adding a new scenario to the repository¶
Create a new branch from
masterusing an appropiate name
Explain what’s the use case in its
How 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 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# Default settings project = 'Test Builds' extensions = [ 'sphinx_autorun', 'sphinx_tabs.tabs', 'sphinx_search.extension', ] latex_engine = 'xelatex' # allow us to build Unicode chars # Include all your settings here html_theme = 'sphinx_rtd_theme'
>>> # Build at >>> import datetime >>> datetime.datetime.utcnow() # UTC datetime.datetime(2021, 2, 17, 15, 5, 36, 429521)