From 178b65293ecc27db073b6d66c8be0aecda3f6934 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Thu, 13 Apr 2023 14:14:24 +0200
Subject: [PATCH] Update documentation, resolve some warnings
---
.gitignore | 1 +
docs/dump-openapi-spec.py | 2 +-
docs/source/{static => _static}/openapi.html | 0
docs/source/conf.py | 2 +-
docs/source/index.rst | 2 +-
5 files changed, 4 insertions(+), 3 deletions(-)
rename docs/source/{static => _static}/openapi.html (100%)
diff --git a/.gitignore b/.gitignore
index 6cf2af7..0834d12 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +5,7 @@ __pycache__
coverage.xml
*.egg-info
docs/build
+docs/source/_static/openapi.json
.vscode
diff --git a/docs/dump-openapi-spec.py b/docs/dump-openapi-spec.py
index 7a453a1..944838a 100644
--- a/docs/dump-openapi-spec.py
+++ b/docs/dump-openapi-spec.py
@@ -6,7 +6,7 @@ import lso
config_filename = os.path.join(
os.path.dirname(__file__),
- '..', 'config-example.json')
+ '..', 'config.json.example')
output_filename = os.path.join(
os.path.dirname(__file__),
diff --git a/docs/source/static/openapi.html b/docs/source/_static/openapi.html
similarity index 100%
rename from docs/source/static/openapi.html
rename to docs/source/_static/openapi.html
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 9d63df7..5623743 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -67,7 +67,7 @@ exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
html_theme = 'sphinx_rtd_theme'
-html_static_path = ['static']
+html_static_path = ['_static']
# Both the class' and the __init__ method's docstring
# are concatenated and inserted.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 3508806..74ff58e 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,5 +1,5 @@
GOAT Lightweight Service Orchestrator
-==========================
+=====================================
Documentation for LSO: a Lightweight Service Orchestrator
--
GitLab