added sitemap to deploy

audiotool · Jun 19, 2023 · 61a667b · 61a667b
1 parent 741208d
commit 61a667b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git 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
@@ -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
@@ -29,7 +29,7 @@ computer so see what your changes look like.
 First, you need to:
 
 * `install sphinx <https://www.sphinx-doc.org/en/master/usage/installation.html>`_
-* 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::