From c0707ab3611b3c6f4127a7ac2b956f63945b28cf Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Thu, 31 Dec 2020 11:46:29 -0800 Subject: [PATCH] doc: prep for upgrading doc build tools Update known-issues list to eliminate known warnings for duplicate declaration warnings because of breathe/sphinx upgrades. Update conf.py to check sphinx version and use appropriate way to include extra javascript and css files depending on the version. Both of these changes will allow the old and new doc tools to not show unanticipated warnings or errors and allow for a smooth upgrade to the CI system (and contributors local doc builds). Signed-off-by: David B. Kinder --- doc/.known-issues/doc/dupdecl.conf | 2 +- doc/conf.py | 16 ++++++++++++---- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/doc/.known-issues/doc/dupdecl.conf b/doc/.known-issues/doc/dupdecl.conf index f7a25ef35..15092e9a9 100644 --- a/doc/.known-issues/doc/dupdecl.conf +++ b/doc/.known-issues/doc/dupdecl.conf @@ -10,5 +10,5 @@ # ^(?P[-._/\w]+/hld/[-._/\w]+.rst):(?P[0-9]+): WARNING: duplicate C object description.* # -^(?P[-._/\w]+/hld/[-._/\w]+.rst):(?P[0-9]+): WARNING: Duplicate C\+\+ declaration, .* +^(?P[-._/\w]+/hld/[-._/\w]+.rst):(?P[0-9]+): WARNING: Duplicate C[\+]* declaration, .* ^Declaration is .* diff --git a/doc/conf.py b/doc/conf.py index 24c3ec199..5d4c7ca18 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -231,10 +231,18 @@ numfig_format = {'figure': 'Figure %s', 'table': 'Table %s', 'code-block': 'Code html_static_path = ['static'] def setup(app): - app.add_stylesheet("acrn-custom.css") - app.add_javascript("https://www.googletagmanager.com/gtag/js?id=UA-831873-64") - # note more GA tag manager calls are in acrn-custom.js - app.add_javascript("acrn-custom.js") + import sphinx + + if float(sphinx.__version__[0:3]) < 3.0: + app.add_stylesheet("acrn-custom.css") + app.add_javascript("https://www.googletagmanager.com/gtag/js?id=UA-831873-64") + # note more GA tag manager calls are in acrn-custom.js + app.add_javascript("acrn-custom.js") + else: + app.add_css_file("acrn-custom.css") + app.add_js_file("https://www.googletagmanager.com/gtag/js?id=UA-831873-64") + # note more GA tag manager calls are in acrn-custom.js + app.add_js_file("acrn-custom.js") # Custom sidebar templates, must be a dictionary that maps document names # to template names.