From 886b6119eea7db78ba75cb15fc5439b2914c8568 Mon Sep 17 00:00:00 2001 From: Bohdan Zhuravel Date: Mon, 16 Sep 2024 14:24:02 +0300 Subject: [PATCH] [DEVOPS-297 DEVOPS-298] Upgrade Sphinx, add sphinx-sitemap --- requirements.txt | 3 ++- source/conf.py | 7 ++++--- source/robots.txt | 3 +++ 3 files changed, 9 insertions(+), 4 deletions(-) create mode 100644 source/robots.txt diff --git a/requirements.txt b/requirements.txt index 386b9e5e5..98b623899 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ -Sphinx==7.3.7 +Sphinx==8.0.2 +sphinx-sitemap==2.6.0 diff --git a/source/conf.py b/source/conf.py index 6716e9b87..857a33319 100644 --- a/source/conf.py +++ b/source/conf.py @@ -28,7 +28,8 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ['sphinx_sitemap'] +sitemap_url_scheme = "{link}" # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -134,7 +135,7 @@ # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +html_extra_path = ['robots.txt'] # If not None, a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. @@ -183,7 +184,7 @@ # The URL which points to the root of the HTML documentation. # It is used to indicate the location of document like canonical_url. -html_baseurl = 'https://docs.talkable.com' +html_baseurl = 'https://docs.talkable.com/' # -- Options for manual page output --------------------------------------- diff --git a/source/robots.txt b/source/robots.txt new file mode 100644 index 000000000..f3fc00670 --- /dev/null +++ b/source/robots.txt @@ -0,0 +1,3 @@ +User-agent: * + +Sitemap: https://docs.talkable.com/sitemap.xml