Add sphinx_tabs_nowarn option

executablebooks · Sep 29, 2017 · 501612e · 501612e
1 parent 4826fc5
commit 501612e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,3 +1,6 @@
+v1.1.5
+ * Add sphinx_tabs_nowarn option to disable warning about incompatible builder. Useful when running sphinx-build with the -W flag
+
 v1.1.4
  * Fix broken javascript file inclusion
 

diff --git a/sphinx_tabs/tabs.py b/sphinx_tabs/tabs.py
@@ -255,11 +255,14 @@ def copy_assets(app, exception):
     builders = ('html', 'readthedocs', 'readthedocssinglehtmllocalmedia',
                 'singlehtml', 'dirhtml')
     if app.builder.name not in builders:
-        app.warn('Not copying tabs assets! Not compatible with %s builder' %
-                 app.builder.name)
+        if not app.config['sphinx_tabs_nowarn']:
+            app.warn(
+                'Not copying tabs assets! Not compatible with %s builder' %
+                app.builder.name)
         return
     if exception:
-        app.warn('Not copying tabs assets! Error occurred previously')
+        if not app.config['sphinx_tabs_nowarn']:
+            app.warn('Not copying tabs assets! Error occurred previously')
         return
     app.info('Copying tabs assets... ', nonl=True)
 
@@ -279,6 +282,7 @@ def copy_assets(app, exception):
 
 def setup(app):
     """ Set up the plugin """
+    app.add_config_value('sphinx_tabs_nowarn', False, '')
     app.add_directive('tabs', TabsDirective)
     app.add_directive('tab', TabDirective)
     app.add_directive('group-tab', GroupTabDirective)