From 61a667b266a6f0d5f05eb4db592858073c1a473c Mon Sep 17 00:00:00 2001 From: Silas Gyger Date: Mon, 19 Jun 2023 15:14:12 +0200 Subject: [PATCH] added sitemap to deploy --- .github/workflows/deploy_docs.yml | 2 +- conf.py | 10 ++++++++-- manuals/other/contribute.rst | 2 +- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index f653fb6..a8fd9a4 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -29,7 +29,7 @@ jobs: - name: Setup packages run: | sudo apt install python3-sphinx make - python -m pip install sphinx-rtd-theme + python -m pip install sphinx-rtd-theme sphinx-sitemap - name: Build run: make html diff --git a/conf.py b/conf.py index 38e0096..ec72485 100644 --- a/conf.py +++ b/conf.py @@ -31,9 +31,13 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autosectionlabel' + 'sphinx.ext.autosectionlabel', + 'sphinx_sitemap' ] +# sphinx_sitemap config +sitemap_url_scheme = "{link}" + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -99,4 +103,6 @@ html_show_sphinx = False -logo_url = "https://images.g2crowd.com/uploads/product/image/social_landscape/social_landscape_d05ec3744972a3774cc038fe42484954/audiotool.png" +html_baseurl = 'https://manual.audiotool.com/' + +# logo_url = "https://images.g2crowd.com/uploads/product/image/social_landscape/social_landscape_d05ec3744972a3774cc038fe42484954/audiotool.png" diff --git a/manuals/other/contribute.rst b/manuals/other/contribute.rst index 6edd482..0b49151 100644 --- a/manuals/other/contribute.rst +++ b/manuals/other/contribute.rst @@ -29,7 +29,7 @@ computer so see what your changes look like. First, you need to: * `install sphinx `_ -* install the theme: ``python3 -m pip install sphinx_rtd_theme`` +* install extension: ``python3 -m pip install sphinx-rtd-theme sphinx-sitemap`` Then, everytime you make a change [#rebuild]_, rebuild with::