update examples and active config files

Issue-ID: DOC-798 Signed-off-by: thmsdt <[email protected]> Change-Id: Ifdf67102aa90e992e3803e279c797143a4ab48c1
collivier · Oct 12, 2022 · 1bd9a4e · 1bd9a4e
1 parent db7450d
commit 1bd9a4e
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 11 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,4 @@
 {
-    "restructuredtext.confPath": "${workspaceFolder}/docs"
+    "restructuredtext.confPath": "${workspaceFolder}/docs",
+    "esbonio.sphinx.confDir": "${workspaceFolder}/docs"
 }
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,8 +17,13 @@
 html_show_sphinx = False
 
 extensions = [
-    'sphinx.ext.intersphinx','sphinxcontrib.blockdiag',
-    'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz']
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.graphviz',
+    'sphinxcontrib.blockdiag',
+    'sphinxcontrib.seqdiag',
+    'sphinxcontrib.swaggerdoc',
+    'sphinxcontrib.plantuml'
+]
 
 #
 # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
@@ -75,3 +80,7 @@
 
 def setup(app):
     app.add_css_file("css/ribbon.css")
+
+linkcheck_ignore = [
+  r'http://localhost:\d+/'
+]
diff --git a/etc/requirements-docs.txt b/etc/requirements-docs.txt
@@ -3,6 +3,7 @@ sphinx-rtd-theme>=1.0.0  # MIT
 sphinxcontrib-blockdiag  # BSD
 sphinxcontrib-seqdiag # BSD
 sphinxcontrib-swaggerdoc
-autopep8
 sphinxcontrib-spelling
+sphinxcontrib-plantuml
+autopep8
 pylint
diff --git a/examples/sphinx/.readthedocs.yaml b/examples/sphinx/.readthedocs.yaml
@@ -12,7 +12,7 @@ build:
 python:
    version: 3.7
    install:
-      - requirements: etc/requirements-docs.txt
+      - requirements: requirements-docs.txt
 
 submodules:
    include: all

diff --git a/examples/sphinx/master/conf.py b/examples/sphinx/master/conf.py
@@ -17,9 +17,13 @@
 html_show_sphinx = False
 
 extensions = [
-    'sphinx.ext.intersphinx','sphinxcontrib.blockdiag',
-    'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz',
-    'sphinxcontrib.spelling']
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.graphviz',
+    'sphinxcontrib.blockdiag',
+    'sphinxcontrib.seqdiag',
+    'sphinxcontrib.swaggerdoc',
+    'sphinxcontrib.plantuml'
+]
 
 #
 # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
@@ -46,3 +50,7 @@
 
 def setup(app):
     app.add_css_file("css/ribbon.css")
+
+linkcheck_ignore = [
+  r'http://localhost:\d+/'
+]
diff --git a/examples/sphinx/master/requirements-docs.txt b/examples/sphinx/master/requirements-docs.txt
@@ -4,3 +4,4 @@ sphinxcontrib-blockdiag  # BSD
 sphinxcontrib-seqdiag # BSD
 sphinxcontrib-swaggerdoc
 sphinxcontrib-spelling
+sphinxcontrib-plantuml
diff --git a/examples/sphinx/release/conf.py b/examples/sphinx/release/conf.py
@@ -17,9 +17,13 @@
 html_show_sphinx = False
 
 extensions = [
-    'sphinx.ext.intersphinx','sphinxcontrib.blockdiag',
-    'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz',
-    'sphinxcontrib.spelling']
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.graphviz',
+    'sphinxcontrib.blockdiag',
+    'sphinxcontrib.seqdiag',
+    'sphinxcontrib.swaggerdoc',
+    'sphinxcontrib.plantuml'
+]
 
 #
 # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
@@ -46,3 +50,7 @@
 
 def setup(app):
     app.add_css_file("css/ribbon.css")
+
+linkcheck_ignore = [
+  r'http://localhost:\d+/'
+]
diff --git a/examples/sphinx/release/requirements-docs.txt b/examples/sphinx/release/requirements-docs.txt
@@ -4,3 +4,4 @@ sphinxcontrib-blockdiag  # BSD
 sphinxcontrib-seqdiag # BSD
 sphinxcontrib-swaggerdoc
 sphinxcontrib-spelling
+sphinxcontrib-plantuml