👌 IMPROVE: Making in-page TOC title configurable

docs/configure.md

@@ -127,6 +127,17 @@ html_theme_options = {
 }
 ```
 
+## Control the right sidebar items
+
+You can rename the title of the in-page table of contents, in the right sidebar:
+
+```python
+html_theme_options = {
+    "toc_title": "{your-title}"
+}
+```
+
+The default value of the title is `Contents`.
 
 ## Control the left sidebar items
 

sphinx_book_theme/__init__.py

@@ -250,9 +250,15 @@ def add_header_level_recursive(ul, level):
         else:
             toc_out = soup.prettify()
 
+        if not context["theme_toc_title"]:
+            raise ValueError(
+                "'toc_title' key cannot be empty. Please set a non-empty value."
+            )
+
         out = f"""
         <div class="tocsection onthispage pt-5 pb-3">
-            <i class="fas fa-list"></i> { context["translate"]('Contents') }
+            <i class="fas fa-list"></i>
+            { context["translate"](context["theme_toc_title"]) }
         </div>
         <nav id="bd-toc-nav">
             {toc_out}

sphinx_book_theme/theme.conf

@@ -21,3 +21,4 @@ use_download_button = True
 use_repository_button = False
 theme_dev_mode = False
 show_navbar_depth = 1
+toc_title = Contents

src/jinja/theme.conf

@@ -20,3 +20,4 @@ use_issues_button = False
 use_repository_button = False
 theme_dev_mode = False
 show_navbar_depth = 1
+toc_title = Contents

src/jinja/theme.conf.j2

@@ -21,3 +21,4 @@ use_download_button = True
 use_repository_button = False
 theme_dev_mode = False
 show_navbar_depth = 1
+toc_title = Contents

tests/sites/base/page1.md

@@ -1,3 +1,11 @@
 # Page 1
 
 Test content with <a href="https://google.com">Some raw HTML</a> to test.
+
+## Section 1
+
+First section
+
+## Section 2
+
+Second section

tests/test_build.py

@@ -1,6 +1,6 @@
 import os
 from pathlib import Path
-from shutil import copytree
+from shutil import copytree, rmtree
 from subprocess import check_call
 
 from bs4 import BeautifulSoup
@@ -300,3 +300,26 @@ def test_topbar_download_button_off(sphinx_build_factory, file_regression):
         "div", attrs={"class": "topbar-main"}
     )[0]
     file_regression.check(source_btns.prettify(), extension=".html", encoding="utf8")
+
+
+def test_right_sidebar_title(sphinx_build_factory, file_regression):
+    confoverrides = {"html_theme_options.toc_title": "My Contents"}
+    sphinx_build = sphinx_build_factory("base", confoverrides=confoverrides).build(
+        assert_pass=True
+    )
+
+    sidebar_title = sphinx_build.html_tree("page1.html").find_all(
+        "div", attrs={"class": "tocsection"}
+    )[0]
+
+    file_regression.check(sidebar_title.prettify(), extension=".html", encoding="utf8")
+
+    # Testing the exception for empty title
+    rmtree(str(sphinx_build.src))
+
+    confoverrides = {"html_theme_options.toc_title": ""}
+
+    with pytest.raises(
+        ThemeError, match="key cannot be empty. Please set a non-empty value."
+    ):
+        sphinx_build_factory("base", confoverrides=confoverrides).build()

tests/test_build/escaped_description.html

@@ -1 +1 @@
-<meta content='Page 1  Test content with &lt;a href="https://google.com"&gt;Some raw HTML&lt;/a&gt; to test.' property="og:description"/>
+<meta content='Page 1  Test content with &lt;a href="https://google.com"&gt;Some raw HTML&lt;/a&gt; to test.  Section 1  First section  Section 2  Second sectionSection 1  First sectionSe' property="og:description"/>

tests/test_build/test_right_sidebar_title.html

@@ -0,0 +1,5 @@
+<div class="tocsection onthispage pt-5 pb-3">
+ <i class="fas fa-list">
+ </i>
+ My Contents
+</div>