* [PATCH] .readthedocs.yml: specify some minimum python requirements
@ 2020-02-06 10:47 Alex Bennée
2020-02-06 10:56 ` Peter Maydell
0 siblings, 1 reply; 2+ messages in thread
From: Alex Bennée @ 2020-02-06 10:47 UTC (permalink / raw)
To: qemu-devel, peter.maydell; +Cc: 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>
---
.readthedocs.yml | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
create mode 100644 .readthedocs.yml
diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 00000000000..99730364bbc
--- /dev/null
+++ b/.readthedocs.yml
@@ -0,0 +1,17 @@
+# .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
+
+# We need at least 3.4 for enum, but we enforce 3.5+ for sphinx
+python:
+ version: 3.5
--
2.20.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] .readthedocs.yml: specify some minimum python requirements
2020-02-06 10:47 [PATCH] .readthedocs.yml: specify some minimum python requirements Alex Bennée
@ 2020-02-06 10:56 ` Peter Maydell
0 siblings, 0 replies; 2+ messages in thread
From: Peter Maydell @ 2020-02-06 10:56 UTC (permalink / raw)
To: Alex Bennée; +Cc: QEMU Developers
On Thu, 6 Feb 2020 at 10:47, Alex Bennée <alex.bennee@linaro.org> 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>
> ---
> .readthedocs.yml | 17 +++++++++++++++++
> 1 file changed, 17 insertions(+)
> create mode 100644 .readthedocs.yml
>
> diff --git a/.readthedocs.yml b/.readthedocs.yml
> new file mode 100644
> index 00000000000..99730364bbc
> --- /dev/null
> +++ b/.readthedocs.yml
> @@ -0,0 +1,17 @@
> +# .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
> +# We need at least 3.4 for enum, but we enforce 3.5+ for sphinx
A better comment IMHO:
# 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.)
Otherwise this will become inaccurate in a couple of weeks
as soon as some other extension code lands that really does
have a 3.5 requirement.
> +python:
> + version: 3.5
Otherwise
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
thanks
-- PMM
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-02-06 11:19 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-02-06 10:47 [PATCH] .readthedocs.yml: specify some minimum python requirements Alex Bennée
2020-02-06 10:56 ` Peter Maydell
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).