Merge branch '2022' of https://github.com/ZeissIQS/gom-software-pytho…

…n-api into 2022
ZeissIQS · Oct 11, 2023 · 1221459 · 1221459
2 parents edd7591 + 9221bc4
commit 1221459
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -10,7 +10,7 @@ jobs:
           python-version: '3.10'
       - name: Install dependencies
         run: |
-          pip install sphinx==6.1.3 sphinx_rtd_theme sphinx-favicon myst_parser
+          pip install sphinx==6.1.3 sphinx_rtd_theme sphinx-favicon myst_parser sphinx_sitemap
       - name: Sphinx build
         run: |
           sphinx-build doc _build

diff --git a/doc/conf.py b/doc/conf.py
@@ -13,7 +13,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['myst_parser', 'sphinx_rtd_theme', 'sphinx_favicon', 'sphinx.ext.githubpages']
+extensions = ['myst_parser', 'sphinx_rtd_theme', 'sphinx_favicon', 'sphinx.ext.githubpages', 'sphinx_sitemap']
 source_suffix = ['.rst', '.md']
 
 templates_path = ['_templates']
@@ -29,6 +29,11 @@
 
 myst_heading_anchors = 4
 
+# -- Options for sitemap -----------------------------------------------------
+# https://sphinx-sitemap.readthedocs.io/en/latest/getting-started.html
+html_baseurl = 'https://zeissiqs.github.io/gom-software-python-api/2022/'
+sitemap_url_scheme = "{link}"
+
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output