Add configuration warning for sphinxcontrib-youtube

Also adds a work around to keep older build environments functional by using sphinxcontrib.vimeo

Sphinxsetup.bat

@@ -1,5 +1,5 @@
 rem remove any existing packages that may cause conflicts
-pip uninstall -y sphinx lxml sphinx-rtd-theme sphinxcontrib-youtube sphinxcontrib.vimeo beautifulsoup4
+pip uninstall -y sphinx lxml sphinx-rtd-theme sphinxcontrib-youtube beautifulsoup4
 
 rem Install sphinx
 pip install --upgrade sphinx
@@ -13,9 +13,6 @@ pip install --upgrade git+https://github.com/ArduPilot/sphinx_rtd_theme.git
 rem and a youtube plugin:
 pip install --upgrade git+https://github.com/sphinx-contrib/youtube.git
 
-rem and a vimeo plugin:
-pip install --upgrade git+https://github.com/ArduPilot/sphinxcontrib.vimeo.git
-
 rem and a parser to use getting posts from Discourse (forum) and insert in FrontEnd
 pip install --upgrade beautifulsoup4
 

Sphinxsetup.sh

@@ -60,9 +60,6 @@ python3 -m pip install --user --upgrade git+https://github.com/ArduPilot/sphinx_
 # and a youtube plugin:
 python3 -m pip install --user --upgrade git+https://github.com/sphinx-contrib/youtube.git
 
-# and a vimeo plugin:
-python3 -m pip install --user --upgrade git+https://github.com/ArduPilot/sphinxcontrib.vimeo.git
-
 # and a parser to use getting posts from Discourse (forum) and insert in FrontEnd
 python3 -m pip install --user --upgrade beautifulsoup4
 

antennatracker/source/conf.py

@@ -33,18 +33,7 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.ifconfig',
-    'sphinxcontrib.youtube', #For youtube embedding
-    'sphinxcontrib.vimeo', #For vimeo embedding
-]
+extensions = common_conf.extensions
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

ardupilot/source/conf.py

@@ -31,18 +31,7 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.ifconfig',
-    'sphinxcontrib.youtube', #For youtube embedding
-    'sphinxcontrib.vimeo', #For vimeo embedding
-]
+extensions = common_conf.extensions
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

blimp/source/conf.py

@@ -33,18 +33,7 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.ifconfig',
-    'sphinxcontrib.youtube', #For youtube embedding
-    'sphinxcontrib.vimeo', #For vimeo embedding
-]
+extensions = common_conf.extensions
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

common_conf.py

@@ -2,7 +2,42 @@
 #
 # This contains common configuration information for the ardupilot wikis.
 # This information is imported by the conf.py files in each of the sub wikis
-#
+
+import warnings
+from packaging import version
+import pkg_resources
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.imgmath',
+    'sphinx.ext.ifconfig',
+    'sphinxcontrib.youtube',  # For youtube embedding
+]
+
+
+def custom_formatwarning(msg, *args, **kwargs):
+    # ignore everything except the message
+    return str(msg) + '\n'
+
+
+warnings.formatwarning = custom_formatwarning
+
+# Check if sphinxcontrib.youtube version is high enough to handle vimeo and older python versions
+if version.parse(pkg_resources.get_distribution('sphinxcontrib-youtube').version) < version.parse('1.0.1'):
+    warnings.warn('\033[93mModule sphinxcontrib-youtube is outdated. PDF documentation cannot be built. ' +
+                  'Please run "python3 -m pip install --upgrade sphinxcontrib-youtube"')
+    try:
+        # Check if sphinxcontrib.vimeo extension is present, fallback to using that to handle vimeo
+        import sphinxcontrib.vimeo  # noqa: F401
+        extensions.append('sphinxcontrib.vimeo')  # For vimeo embedding
+    except ImportError:  # change to ModuleNotFoundError when only python >=3.6 is supported
+        warnings.warn('\033[93mModule sphinxcontrib-youtube is old and sphinxcontrib-vimeo is not installed.' +
+                      'Please run the wiki build setup script.')
 
 # Set False to re-enable warnings for non-local images.
 disable_non_local_image_warnings = True

copter/source/conf.py

@@ -33,18 +33,7 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.ifconfig',
-    'sphinxcontrib.youtube', #For youtube embedding
-    'sphinxcontrib.vimeo', #For vimeo embedding
-]
+extensions = common_conf.extensions
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

dev/source/conf.py

@@ -31,18 +31,7 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.ifconfig',
-    'sphinxcontrib.youtube', #For youtube embedding
-    'sphinxcontrib.vimeo', #For vimeo embedding
-]
+extensions = common_conf.extensions
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

mavproxy/source/conf.py

@@ -31,18 +31,7 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.ifconfig',
-    'sphinxcontrib.youtube', #For youtube embedding
-    'sphinxcontrib.vimeo', #For vimeo embedding
-]
+extensions = common_conf.extensions
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

plane/source/conf.py

@@ -33,18 +33,7 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.ifconfig',
-    'sphinxcontrib.youtube', #For youtube embedding
-    'sphinxcontrib.vimeo', #For vimeo embedding
-]
+extensions = common_conf.extensions
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

planner/source/conf.py

@@ -31,18 +31,7 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.ifconfig',
-    'sphinxcontrib.youtube', #For youtube embedding
-    'sphinxcontrib.vimeo', #For vimeo embedding
-]
+extensions = common_conf.extensions
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

planner2/source/conf.py

@@ -31,18 +31,7 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.ifconfig',
-    'sphinxcontrib.youtube', #For youtube embedding
-    'sphinxcontrib.vimeo', #For vimeo embedding
-]
+extensions = common_conf.extensions
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

rover/source/conf.py

@@ -33,18 +33,7 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.ifconfig',
-    'sphinxcontrib.youtube', #For youtube embedding
-    'sphinxcontrib.vimeo', #For vimeo embedding
-]
+extensions = common_conf.extensions
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']