diff options
| -rw-r--r-- | .vscode/settings.json | 3 | ||||
| -rw-r--r-- | docs/conf.py | 13 | ||||
| -rw-r--r-- | etc/requirements-docs.txt | 3 | ||||
| -rw-r--r-- | examples/sphinx/.readthedocs.yaml | 2 | ||||
| -rw-r--r-- | examples/sphinx/master/conf.py | 14 | ||||
| -rw-r--r-- | examples/sphinx/master/requirements-docs.txt | 1 | ||||
| -rw-r--r-- | examples/sphinx/release/conf.py | 14 | ||||
| -rw-r--r-- | examples/sphinx/release/requirements-docs.txt | 1 |
8 files changed, 40 insertions, 11 deletions
diff --git a/.vscode/settings.json b/.vscode/settings.json index 12ff2fdb0..7f21c6029 100644 --- 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" }
\ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index f54fd995b..13caa5513 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,8 +17,13 @@ html_static_path = ["_static"] 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 @@ 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/etc/requirements-docs.txt b/etc/requirements-docs.txt index dc55d67b4..d2ddef1e5 100644 --- 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 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 |