summaryrefslogtreecommitdiffstats
path: root/examples/sphinx
diff options
context:
space:
mode:
authorthmsdt <thomas.kulik@telekom.de>2022-10-12 12:34:03 +0200
committerthmsdt <thomas.kulik@telekom.de>2022-10-12 12:44:19 +0200
commit1bd9a4e3122e568df33dbe86d8bc922ebabc652e (patch)
tree4d96e1594de1f35967678d5a3717b5d3ff4f6721 /examples/sphinx
parentdb7450db882ceb69929974183642228e1e566f54 (diff)
update examples and active config files
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ifdf67102aa90e992e3803e279c797143a4ab48c1
Diffstat (limited to 'examples/sphinx')
-rw-r--r--examples/sphinx/.readthedocs.yaml2
-rw-r--r--examples/sphinx/master/conf.py14
-rw-r--r--examples/sphinx/master/requirements-docs.txt1
-rw-r--r--examples/sphinx/release/conf.py14
-rw-r--r--examples/sphinx/release/requirements-docs.txt1
5 files changed, 25 insertions, 7 deletions
diff --git a/examples/sphinx/.readthedocs.yaml b/examples/sphinx/.readthedocs.yaml
index 9972e7212..49997a761 100644
--- 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
index e15eeeec4..a9c42b672 100644
--- a/examples/sphinx/master/conf.py
+++ b/examples/sphinx/master/conf.py
@@ -17,9 +17,13 @@ html_static_path = ["_static"]
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 @@ html_last_updated_fmt = '%d-%b-%y %H:%M'
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
index ed96b42b7..71df2ab0d 100644
--- 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
index 7976b6d51..e13e05171 100644
--- a/examples/sphinx/release/conf.py
+++ b/examples/sphinx/release/conf.py
@@ -17,9 +17,13 @@ html_static_path = ["_static"]
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 @@ html_last_updated_fmt = '%d-%b-%y %H:%M'
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
index ed96b42b7..71df2ab0d 100644
--- 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