[PATCH v2] .readthedocs.yml: specify some minimum python requirements

[PATCH v2] .readthedocs.yml: specify some minimum python requirements

[Alex Bennée]

QEMU is all about the Python 3 now so lets also hint that to
ReadTheDocs in its config file.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

---
If anyone wants to include this is their next PR please do, otherwise
it will be a misc patch in my next series ;-)
---
 .readthedocs.yml | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 .readthedocs.yml

diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 00000000000..8355dbc6343
--- /dev/null
+++ b/.readthedocs.yml
@@ -0,0 +1,20 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We want all the document formats
+formats: all
+
+# For consistency, we require that QEMU's Sphinx extensions
+# run with at least the same minimum version of Python that
+# we require for other Python in our codebase (our conf.py
+# enforces this, and some code needs it.)
+python:
+  version: 3.5
-- 
2.20.1

Re: [PATCH v2] .readthedocs.yml: specify some minimum python requirements

[Philippe Mathieu-Daudé]

On 2/6/20 5:31 PM, Alex Bennée wrote:
> QEMU is all about the Python 3 now so lets also hint that to
> ReadTheDocs in its config file.
> 
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> 
> ---
> If anyone wants to include this is their next PR please do, otherwise
> it will be a misc patch in my next series ;-)
> ---
>   .readthedocs.yml | 20 ++++++++++++++++++++
>   1 file changed, 20 insertions(+)
>   create mode 100644 .readthedocs.yml
> 
> diff --git a/.readthedocs.yml b/.readthedocs.yml
> new file mode 100644
> index 00000000000..8355dbc6343
> --- /dev/null
> +++ b/.readthedocs.yml
> @@ -0,0 +1,20 @@
> +# .readthedocs.yml
> +# Read the Docs configuration file
> +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
> +
> +# Required
> +version: 2
> +
> +# Build documentation in the docs/ directory with Sphinx
> +sphinx:
> +  configuration: docs/conf.py
> +
> +# We want all the document formats
> +formats: all
> +
> +# For consistency, we require that QEMU's Sphinx extensions
> +# run with at least the same minimum version of Python that
> +# we require for other Python in our codebase (our conf.py
> +# enforces this, and some code needs it.)
> +python:
> +  version: 3.5
> 

I wonder if this could also help:

   submodules:
     exclude: all

See https://docs.readthedocs.io/en/stable/config-file/v2.html#submodules

Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>

Patch applied to my python-next tree:
https://gitlab.com/philmd/qemu/commits/python-next