Skip to contentSkip to conversation

docs: Fix conf.py for Sphinx 2.0

PATCH New Sean Anderson 2 participants 3 messages Mar 20, 2020 – Apr 24, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: Fix conf.py for Sphinx 2.0

From: Jonathan Corbet <[email protected]>

commit 3bc8088464712fdcb078eefb68837ccfcc413c88 upstream.

Our version check in Documentation/conf.py never envisioned a world where Sphinx moved beyond 1.x. Now that the unthinkable has happened, fix our version check to handle higher version numbers correctly.

[rebase for u-boot]

---

 doc/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/conf.py +1 -1
index 0772fb6f0c..8bb27ad9e2 100644
@@ -37,7 +37,7 @@ needs_sphinx = '1.3'
 extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain', 'kfigure']
 
 # The name of the math extension changed on Sphinx 1.4
-if major == 1 and minor > 3:
+if (major == 1 and minor > 3) or (major > 1):
     extensions.append("sphinx.ext.imgmath")
 else:
     extensions.append("sphinx.ext.pngmath")
Signature · 1 line
2.25.1
#1 lore raw

PATCH 1/1 docs: Fix conf.py for Sphinx 2.0

Quoted 22 lines · Sean Anderson

From: Jonathan Corbet <[email protected]>

commit 3bc8088464712fdcb078eefb68837ccfcc413c88 upstream.

Our version check in Documentation/conf.py never envisioned a world where Sphinx moved beyond 1.x. Now that the unthinkable has happened, fix our version check to handle higher version numbers correctly.

[rebase for u-boot]

---

 doc/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/conf.py +0 -0
index 0772fb6f0c..8bb27ad9e2 100644

doc/conf.py needs_sphinx = '1.3' · line 43

Quoted 8 lines
doc/conf.py +1 -1
@@ -37,7 +37,7 @@ needs_sphinx = '1.3'
 extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain', 'kfigure']
 
 # The name of the math extension changed on Sphinx 1.4
-if major == 1 and minor > 3:
+if (major == 1 and minor > 3) or (major > 1):
     extensions.append("sphinx.ext.imgmath")
 else:
     extensions.append("sphinx.ext.pngmath")

*bump*

It's been a month, any comments on this?

--Sean

#2 lore raw

PATCH 1/1 docs: Fix conf.py for Sphinx 2.0

In reply to Sean Anderson
Quoted 11 lines · Sean Anderson

From: Jonathan Corbet <[email protected]>

commit 3bc8088464712fdcb078eefb68837ccfcc413c88 upstream.

Our version check in Documentation/conf.py never envisioned a world where Sphinx moved beyond 1.x. Now that the unthinkable has happened, fix our version check to handle higher version numbers correctly.

[rebase for u-boot]

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20200424/ee4a0436/attachment.sig>