├── .gitignore
├── requirements.txt
├── docs
    ├── conf.rst
    ├── contents.rst
    ├── conf.py
    └── index.rst
├── .readthedocs.yaml
└── README.rst


/.gitignore:
--------------------------------------------------------------------------------
1 | docs/_build
2 | .python-version
3 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | sphinx-autorun
2 | sphinx-rtd-theme>=3.1.0rc1
3 | 


--------------------------------------------------------------------------------
/docs/conf.rst:
--------------------------------------------------------------------------------
1 | conf.py
2 | =======
3 | 
4 | .. literalinclude:: conf.py
5 |    :language: python
6 |    :linenos:
7 | 


--------------------------------------------------------------------------------
/docs/contents.rst:
--------------------------------------------------------------------------------
 1 | Contents
 2 | ========
 3 | 
 4 | All contents of this documentation.
 5 | 
 6 | .. toctree::
 7 |    :glob:
 8 | 
 9 |    *
10 | 


--------------------------------------------------------------------------------
/.readthedocs.yaml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | 
 3 | build:
 4 |   os: ubuntu-24.04
 5 |   tools:
 6 |     python: latest
 7 | 
 8 | sphinx:
 9 |   configuration: docs/conf.py
10 | 
11 | python:
12 |   install:
13 |     - requirements: requirements.txt
14 | 


--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | 
 3 | # Default settings
 4 | project = 'Test Builds'
 5 | extensions = [
 6 |     'sphinx_autorun',
 7 | ]
 8 | 
 9 | latex_engine = 'xelatex'  # allow us to build Unicode chars
10 | 
11 | 
12 | # Include all your settings here
13 | html_theme = 'sphinx_rtd_theme'
14 | 


--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
 1 | test-builds
 2 | ===========
 3 | 
 4 | GitHub repository to test different Read the Docs builds scenarios.
 5 | 
 6 | ----
 7 | 
 8 | Read the Docs configuration file used to build this docs:
 9 | 
10 | .. literalinclude:: ../.readthedocs.yaml
11 |    :language: yaml
12 |    :linenos:
13 | 
14 | ----
15 | 
16 | Sphinx configuration file used to build this docs (:doc:`see full file <conf>`),
17 | 
18 | .. literalinclude:: conf.py
19 |    :language: python
20 |    :end-before: ###########################################################################
21 |    :linenos:
22 | 
23 | ----
24 | 
25 | .. runblock:: pycon
26 | 
27 |    >>> # Build at
28 |    >>> import datetime
29 |    >>> datetime.datetime.utcnow()  # UTC
30 | 


--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
 1 | Test Builds
 2 | ===========
 3 | 
 4 | This repository is used internally to create different scenarios
 5 | on build configs and trigger many builds on Read the Docs productions.
 6 | 
 7 | Each branch should explain on it's ``docs/index.rst`` what's about and how the
 8 | QA process can be considered a success or a failure.
 9 | 
10 | If we need to test a very specific use case, we create a new branch with
11 | the issue number and the repository, like: ``issue-1234-org``, ``issue-4321-ext`` or similar.
12 | 
13 | 
14 | Scenarios
15 | ---------
16 | 
17 | Each of these scenarios is a branch that can be built independently from the others.
18 | 
19 | Please, check `all the branches <https://github.com/readthedocs/test-builds/branches/>`_ and
20 | `all the tags <https://github.com/readthedocs/test-builds/tags/>`_ to be sure.
21 | 
22 | 
23 | 
24 | Adding a new scenario to the repository
25 | ---------------------------------------
26 | 
27 | #. Create a new branch from ``master`` using an appropiate name
28 | #. Explain what's the use case in its ``docs/index.rst`` file
29 | 
30 |    * How to check if the QA can be considered success or failure
31 |    * Add links to the issue tracker where there are more information
32 | #. Add or modify the necessary files
33 | 
34 |    * Make sure that these files contains the minimum configuration needed:
35 | 
36 |      * remove auto generated comments
37 |      * configs not used
38 | #. Push your changes
39 | 


--------------------------------------------------------------------------------