diff mbox series

[v2] doc: Sphinx.override_domain() deprecated

Message ID 20201006155659.29175-1-xypron.glpk@gmx.de
State Accepted
Commit 40a3008632abd8bb393eefc212547456f2a5cb25
Delegated to: Tom Rini
Headers show
Series [v2] doc: Sphinx.override_domain() deprecated | expand

Commit Message

Heinrich Schuchardt Oct. 6, 2020, 3:56 p.m. UTC
Sphinx.override_domain() is deprecated since Sphinx 1.8 and removed in
Sphinx 3.

Use Sphinx.add_domain(, override=True) instead.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
v2:
	Ubuntu 18.04 still uses Sphinx 1.6.7
	So use the same version check as Linux.
---
 doc/sphinx/cdomain.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--
2.28.0

Comments

Tom Rini Oct. 14, 2020, 5:43 p.m. UTC | #1
On Tue, Oct 06, 2020 at 05:56:59PM +0200, Heinrich Schuchardt wrote:

> Sphinx.override_domain() is deprecated since Sphinx 1.8 and removed in
> Sphinx 3.
> 
> Use Sphinx.add_domain(, override=True) instead.
> 
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

Applied to u-boot/master, thanks!
diff mbox series

Patch

diff --git a/doc/sphinx/cdomain.py b/doc/sphinx/cdomain.py
index cf13ff3a65..e0c762caa6 100644
--- a/doc/sphinx/cdomain.py
+++ b/doc/sphinx/cdomain.py
@@ -48,7 +48,10 @@  major, minor, patch = sphinx.version_info[:3]

 def setup(app):

-    app.override_domain(CDomain)
+    if (major == 1 and minor < 8):
+        app.override_domain(CDomain)
+    else:
+        app.add_domain(CDomain, override=True)

     return dict(
         version = __version__,