Read The Docs now requires a configuration file, which is awkward when using
RTD to render proposed changes on the list.

Provide the minimal configuration file possible, sacrificing all
reproducibility in order to hopefully not need to touch it moving forwards.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---
CC: Anthony PERARD <anthony.perard@vates.tech>
CC: Michal Orzel <michal.orzel@amd.com>
CC: Jan Beulich <jbeulich@suse.com>
CC: Julien Grall <julien@xen.org>
CC: Roger Pau Monné <roger.pau@citrix.com>
CC: Stefano Stabellini <sstabellini@kernel.org>

Notably, I've figured out how to get back to using rtd-theme:

  https://andrewcoop-xen.readthedocs.io/en/docs-secureboot/admin-guide/uefi-secure-boot.html

and without needing a separate docs/requirements.txt file in the tree too.
---
 .readthedocs.yaml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 .readthedocs.yaml

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 000000000000..d3aff7662ebf
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,18 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-lts-latest
+
+  tools:
+    python: "latest"
+
+  jobs:
+    post_install:
+      # Instead of needing a separate requirements.txt
+      - python -m pip install --upgrade --no-cache-dir sphinx-rtd-theme
+
+sphinx:
+  configuration: docs/conf.py
-- 
2.39.5

On Fri, 20 Jun 2025, Andrew Cooper wrote:
> Read The Docs now requires a configuration file, which is awkward when using
> RTD to render proposed changes on the list.
> 
> Provide the minimal configuration file possible, sacrificing all
> reproducibility in order to hopefully not need to touch it moving forwards.
> 
> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>

Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>


> ---
> CC: Anthony PERARD <anthony.perard@vates.tech>
> CC: Michal Orzel <michal.orzel@amd.com>
> CC: Jan Beulich <jbeulich@suse.com>
> CC: Julien Grall <julien@xen.org>
> CC: Roger Pau Monné <roger.pau@citrix.com>
> CC: Stefano Stabellini <sstabellini@kernel.org>
> 
> Notably, I've figured out how to get back to using rtd-theme:
> 
>   https://andrewcoop-xen.readthedocs.io/en/docs-secureboot/admin-guide/uefi-secure-boot.html
> 
> and without needing a separate docs/requirements.txt file in the tree too.
> ---
>  .readthedocs.yaml | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
>  create mode 100644 .readthedocs.yaml
> 
> diff --git a/.readthedocs.yaml b/.readthedocs.yaml
> new file mode 100644
> index 000000000000..d3aff7662ebf
> --- /dev/null
> +++ b/.readthedocs.yaml
> @@ -0,0 +1,18 @@
> +# Read the Docs configuration file for Sphinx projects
> +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
> +
> +version: 2
> +
> +build:
> +  os: ubuntu-lts-latest
> +
> +  tools:
> +    python: "latest"
> +
> +  jobs:
> +    post_install:
> +      # Instead of needing a separate requirements.txt
> +      - python -m pip install --upgrade --no-cache-dir sphinx-rtd-theme
> +
> +sphinx:
> +  configuration: docs/conf.py
> -- 
> 2.39.5
>