From: Eduardo Habkost <ehabkost@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Fam Zheng" <fam@euphon.net>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Philippe Mathieu-Daudé" <philmd@redhat.com>,
"Alex Bennée" <alex.bennee@linaro.org>
Subject: [PATCH 1/2] travis: Check if docs can be built with multiple Sphinx versions
Date: Mon, 19 Oct 2020 10:31:08 -0400 [thread overview]
Message-ID: <20201019143109.1034864-1-ehabkost@redhat.com> (raw)
Add new jobs to .travis.yml to test if docs can be built with
multiple Sphinx versions: 1.6.1, latest 1.x, 2.0.0, and latest
2.x.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
.travis.yml | 37 +++++++++++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
diff --git a/.travis.yml b/.travis.yml
index 1054ec5d29..f5208301d6 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -181,6 +181,43 @@ jobs:
- perl
+ # Check we can build docs with multiple Sphinx versions.
+ # We need --sphinx-build=sphinx-build to ensure we use the
+ # sphinx-build binary installed by pip.
+
+ # 1.6.1 is the oldest Sphinx version we support
+ - name: "docs (Sphinx 1.6.1)"
+ env:
+ - CONFIG="--enable-docs --sphinx-build=sphinx-build"
+ install:
+ - pip install -q sphinx==1.6.1
+ script:
+ - make -j${JOBS} sphinxdocs
+ - name: "docs (Sphinx 1.x)"
+ env:
+ - CONFIG="--enable-docs --sphinx-build=sphinx-build"
+ install:
+ # install latest 1.x version
+ - pip install -q 'sphinx>=1.0,<2.0'
+ script:
+ - make -j${JOBS} sphinxdocs
+ - name: "docs (Sphinx 2.0.0)"
+ env:
+ - CONFIG="--enable-docs --sphinx-build=sphinx-build"
+ install:
+ - pip install -q sphinx==2.0.0
+ script:
+ - make -j${JOBS} sphinxdocs
+ - name: "docs (Sphinx 2.x)"
+ env:
+ - CONFIG="--enable-docs --sphinx-build=sphinx-build"
+ install:
+ # install latest 2.x version
+ - pip install -q 'sphinx>=2.0,<3.0'
+ script:
+ - make -j${JOBS} sphinxdocs
+
+
# Test with Clang for compile portability (Travis uses clang-5.0)
- name: "Clang (user)"
env:
--
2.28.0
next reply other threads:[~2020-10-19 14:33 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-19 14:31 Eduardo Habkost [this message]
2020-10-19 14:31 ` [PATCH 2/2] travis: Remove docs from "tools and docs" job Eduardo Habkost
2020-10-19 14:42 ` [PATCH 1/2] travis: Check if docs can be built with multiple Sphinx versions Daniel P. Berrangé
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201019143109.1034864-1-ehabkost@redhat.com \
--to=ehabkost@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=fam@euphon.net \
--cc=peter.maydell@linaro.org \
--cc=philmd@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).