[dpdk-stable] patch 'doc: fix sphinx rtd theme import in GHA' has been queued to stable release 19.11.9

[Christian Ehrhardt]

Hi,

FYI, your patch has been queued to stable release 19.11.9

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 05/19/21. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/cpaelzer/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/cpaelzer/dpdk-stable-queue/commit/df6515ef82f9dfc0aaceca346582c01b45090904

Thanks.

Christian Ehrhardt <christian.ehrhardt at canonical.com>

---
>From df6515ef82f9dfc0aaceca346582c01b45090904 Mon Sep 17 00:00:00 2001
From: David Marchand <david.marchand at redhat.com>
Date: Thu, 1 Apr 2021 21:58:42 +0200
Subject: [PATCH] doc: fix sphinx rtd theme import in GHA

[ upstream commit aa9cb78f66c53728593c1f65f69f2bbc7ca4a4a9 ]

If the rtd theme is available, passing it by name is enough to select
it. Sphinx itself recognises the "sphinx_rtd_theme" name as a special
case and tries to find its path automatically.

On the other hand, passing a html_theme_path makes sphinx parse all
themes availables in this path, which in some environment (like GHA) is
/usr/share and makes sphinx error on the first zipfile it finds (in GHA,
some Azure CLI thingy) that has no sphinx theme in it.

Fixes: 46562be65094 ("doc: import sphinx rtd theme when available")

Signed-off-by: David Marchand <david.marchand at redhat.com>
Acked-by: Aaron Conole <aconole at redhat.com>
---
 doc/guides/conf.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index c1a82be95b..be02c2ba20 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -25,7 +25,6 @@ try:
     import sphinx_rtd_theme
 
     html_theme = "sphinx_rtd_theme"
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 except:
     print('Install the sphinx ReadTheDocs theme for improved html documentation '
           'layout: pip install sphinx_rtd_theme')
-- 
2.31.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2021-05-17 17:40:32.517367246 +0200
+++ 0077-doc-fix-sphinx-rtd-theme-import-in-GHA.patch	2021-05-17 17:40:29.243810043 +0200
@@ -1 +1 @@
-From aa9cb78f66c53728593c1f65f69f2bbc7ca4a4a9 Mon Sep 17 00:00:00 2001
+From df6515ef82f9dfc0aaceca346582c01b45090904 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit aa9cb78f66c53728593c1f65f69f2bbc7ca4a4a9 ]
+
@@ -16 +17,0 @@
-Cc: stable at dpdk.org
@@ -25 +26 @@
-index aceeb62a4f..ec59aeae7e 100644
+index c1a82be95b..be02c2ba20 100644
@@ -28 +29 @@
-@@ -20,7 +20,6 @@ try:
+@@ -25,7 +25,6 @@ try:
@@ -35 +36 @@
-           'layout: https://sphinx-rtd-theme.readthedocs.io/',
+           'layout: pip install sphinx_rtd_theme')