[PATCH] pythondeps.toml: warn about updates needed to docs/requirements.txt

[PATCH] pythondeps.toml: warn about updates needed to docs/requirements.txt

[Paolo Bonzini]

docs/requirements.txt is expected by readthedocs and should be in sync
with pythondeps.toml.  Add a comment to both.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 docs/requirements.txt | 3 +++
 pythondeps.toml       | 1 +
 2 files changed, 4 insertions(+)

diff --git a/docs/requirements.txt b/docs/requirements.txt
index 691e5218ec7..02583f209aa 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,2 +1,5 @@
+# Used by readthedocs.io
+# Should be in sync with the "installed" key of pythondeps.toml
+
 sphinx==5.3.0
 sphinx_rtd_theme==1.1.1
diff --git a/pythondeps.toml b/pythondeps.toml
index 0e884159993..9c16602d303 100644
--- a/pythondeps.toml
+++ b/pythondeps.toml
@@ -22,6 +22,7 @@
 meson = { accepted = ">=0.63.0", installed = "1.2.3", canary = "meson" }
 
 [docs]
+# Please keep the installed versions in sync with docs/requirements.txt
 sphinx = { accepted = ">=1.6", installed = "5.3.0", canary = "sphinx-build" }
 sphinx_rtd_theme = { accepted = ">=0.5", installed = "1.1.1" }
 
-- 
2.44.0

Re: [PATCH] pythondeps.toml: warn about updates needed to docs/requirements.txt

[Philippe Mathieu-Daudé]

On 18/4/24 11:16, Paolo Bonzini wrote:
> docs/requirements.txt is expected by readthedocs and should be in sync
> with pythondeps.toml.  Add a comment to both.
> 
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>   docs/requirements.txt | 3 +++
>   pythondeps.toml       | 1 +
>   2 files changed, 4 insertions(+)

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>