Sphinx 7.2.6__py3-none-any.whl → 7.3.0__py3-none-any.whl

sphinx/themes/basic/search.html

@@ -4,7 +4,7 @@
 
     Template for the search page.
 
-    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "layout.html" %}
@@ -15,8 +15,9 @@
     <script src="{{ pathto('_static/language_data.js', 1) }}"></script>
 {%- endblock %}
 {% block extrahead %}
-  <script src="{{ pathto('searchindex.js', 1) }}" defer></script>
-  {{ super() }}
+    <script src="{{ pathto('searchindex.js', 1) }}" defer="defer"></script>
+    <meta name="robots" content="noindex" />
+    {{ super() }}
 {% endblock %}
 {% block body %}
   <h1 id="search-documentation">{{ _('Search') }}</h1>
@@ -44,22 +45,6 @@
   </form>
   {% endblock %}
   {% block searchresults %}
-  {% if search_performed %}
-    <h2>{{ _('Search Results') }}</h2>
-    {% if not search_results %}
-      <p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
-    {% endif %}
-  {% endif %}
-  <div id="search-results">
-  {% if search_results %}
-    <ul>
-    {% for href, caption, context in search_results %}
-      <li><a href="{{ pathto(item.href) }}">{{ caption }}</a>
-        <div class="context">{{ context|e }}</div>
-      </li>
-    {% endfor %}
-    </ul>
-  {% endif %}
-  </div>
+  <div id="search-results"></div>
   {% endblock %}
 {% endblock %}

sphinx/themes/basic/searchbox.html

@@ -4,11 +4,11 @@
 
     Sphinx sidebar template: quick search box.
 
-    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- if pagename != "search" and builder != "singlehtml" %}
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">{{ _('Quick search') }}</h3>
     <div class="searchformwrapper">
     <form class="search" action="{{ pathto('search') }}" method="get">
@@ -16,6 +16,6 @@
       <input type="submit" value="{{ _('Go') }}" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
 {%- endif %}

sphinx/themes/basic/searchfield.html

@@ -7,17 +7,17 @@
     extra heading ("Quick search"). Instead, it uses a placeholder text
     in the search field.
 
-    :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- if pagename != "search" and builder != "singlehtml" %}
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
     <div class="searchformwrapper">
     <form class="search" action="{{ pathto('search') }}" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
       <input type="submit" value="{{ _('Go') }}" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
 {%- endif %}

sphinx/themes/basic/sourcelink.html

@@ -4,7 +4,7 @@
 
     Sphinx sidebar template: "show source" link.
 
-    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- if show_source and has_source and sourcename %}

sphinx/themes/basic/static/basic.css_t

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

sphinx/themes/basic/static/doctools.js

@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

sphinx/themes/basic/static/language_data.js_t

@@ -5,7 +5,7 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -13,7 +13,7 @@
 var stopwords = {{ search_language_stop_words }};
 
 {% if search_language_stemming_code %}
-/* Non-minified version is copied as a separate JS file, is available */
+/* Non-minified version is copied as a separate JS file, if available */
 {{ search_language_stemming_code|safe }}
 {% endif -%}
 

sphinx/themes/basic/static/searchtools.js

@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -99,7 +99,7 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
       .then((data) => {
         if (data)
           listItem.appendChild(
-            Search.makeSearchSummary(data, searchTerms)
+            Search.makeSearchSummary(data, searchTerms, anchor)
           );
         // highlight search terms in the summary
         if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
@@ -116,8 +116,8 @@ const _finishSearch = (resultCount) => {
     );
   else
     Search.status.innerText = _(
-      `Search finished, found ${resultCount} page(s) matching the search query.`
-    );
+      "Search finished, found ${resultCount} page(s) matching the search query."
+    ).replace('${resultCount}', resultCount);
 };
 const _displayNextItem = (
   results,
@@ -137,6 +137,22 @@ const _displayNextItem = (
   // search finished, update title and status message
   else _finishSearch(resultCount);
 };
+// Helper function used by query() to order search results.
+// Each input is an array of [docname, title, anchor, descr, score, filename].
+// Order the results by score (in opposite order of appearance, since the
+// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
+const _orderResultsByScoreThenName = (a, b) => {
+  const leftScore = a[4];
+  const rightScore = b[4];
+  if (leftScore === rightScore) {
+    // same score: sort alphabetically
+    const leftTitle = a[1].toLowerCase();
+    const rightTitle = b[1].toLowerCase();
+    if (leftTitle === rightTitle) return 0;
+    return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+  }
+  return leftScore > rightScore ? 1 : -1;
+};
 
 /**
  * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
@@ -160,13 +176,26 @@ const Search = {
   _queued_query: null,
   _pulse_status: -1,
 
-  htmlToText: (htmlString) => {
+  htmlToText: (htmlString, anchor) => {
     const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
-    htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
+    for (const removalQuery of [".headerlinks", "script", "style"]) {
+      htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
+    }
+    if (anchor) {
+      const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
+      if (anchorContent) return anchorContent.textContent;
+
+      console.warn(
+        `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
+      );
+    }
+
+    // if anchor not specified or not found, fall back to main content
     const docContent = htmlElement.querySelector('[role="main"]');
-    if (docContent !== undefined) return docContent.textContent;
+    if (docContent) return docContent.textContent;
+
     console.warn(
-      "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
+      "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
     );
     return "";
   },
@@ -239,16 +268,7 @@ const Search = {
     else Search.deferQuery(query);
   },
 
-  /**
-   * execute search (requires search index to be loaded)
-   */
-  query: (query) => {
-    const filenames = Search._index.filenames;
-    const docNames = Search._index.docnames;
-    const titles = Search._index.titles;
-    const allTitles = Search._index.alltitles;
-    const indexEntries = Search._index.indexentries;
-
+  _parseQuery: (query) => {
     // stem the search terms and add them to the correct list
     const stemmer = new Stemmer();
     const searchTerms = new Set();
@@ -284,16 +304,32 @@ const Search = {
     // console.info("required: ", [...searchTerms]);
     // console.info("excluded: ", [...excludedTerms]);
 
-    // array of [docname, title, anchor, descr, score, filename]
-    let results = [];
+    return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
+  },
+
+  /**
+   * execute search (requires search index to be loaded)
+   */
+  _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
+    const filenames = Search._index.filenames;
+    const docNames = Search._index.docnames;
+    const titles = Search._index.titles;
+    const allTitles = Search._index.alltitles;
+    const indexEntries = Search._index.indexentries;
+
+    // Collect multiple result groups to be sorted separately and then ordered.
+    // Each is an array of [docname, title, anchor, descr, score, filename].
+    const normalResults = [];
+    const nonMainIndexResults = [];
+
     _removeChildren(document.getElementById("search-progress"));
 
-    const queryLower = query.toLowerCase();
+    const queryLower = query.toLowerCase().trim();
     for (const [title, foundTitles] of Object.entries(allTitles)) {
-      if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
+      if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
         for (const [file, id] of foundTitles) {
           let score = Math.round(100 * queryLower.length / title.length)
-          results.push([
+          normalResults.push([
             docNames[file],
             titles[file] !== title ? `${titles[file]} > ${title}` : title,
             id !== null ? "#" + id : "",
@@ -308,46 +344,47 @@ const Search = {
     // search for explicit entries in index directives
     for (const [entry, foundEntries] of Object.entries(indexEntries)) {
       if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
-        for (const [file, id] of foundEntries) {
-          let score = Math.round(100 * queryLower.length / entry.length)
-          results.push([
+        for (const [file, id, isMain] of foundEntries) {
+          const score = Math.round(100 * queryLower.length / entry.length);
+          const result = [
             docNames[file],
             titles[file],
             id ? "#" + id : "",
             null,
             score,
             filenames[file],
-          ]);
+          ];
+          if (isMain) {
+            normalResults.push(result);
+          } else {
+            nonMainIndexResults.push(result);
+          }
         }
       }
     }
 
     // lookup as object
     objectTerms.forEach((term) =>
-      results.push(...Search.performObjectSearch(term, objectTerms))
+      normalResults.push(...Search.performObjectSearch(term, objectTerms))
     );
 
     // lookup as search terms in fulltext
-    results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+    normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
 
     // let the scorer override scores with a custom scoring function
-    if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
-
-    // now sort the results by score (in opposite order of appearance, since the
-    // display function below uses pop() to retrieve items) and then
-    // alphabetically
-    results.sort((a, b) => {
-      const leftScore = a[4];
-      const rightScore = b[4];
-      if (leftScore === rightScore) {
-        // same score: sort alphabetically
-        const leftTitle = a[1].toLowerCase();
-        const rightTitle = b[1].toLowerCase();
-        if (leftTitle === rightTitle) return 0;
-        return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
-      }
-      return leftScore > rightScore ? 1 : -1;
-    });
+    if (Scorer.score) {
+      normalResults.forEach((item) => (item[4] = Scorer.score(item)));
+      nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
+    }
+
+    // Sort each group of results by score and then alphabetically by name.
+    normalResults.sort(_orderResultsByScoreThenName);
+    nonMainIndexResults.sort(_orderResultsByScoreThenName);
+
+    // Combine the result groups in (reverse) order.
+    // Non-main index entries are typically arbitrary cross-references,
+    // so display them after other results.
+    let results = [...nonMainIndexResults, ...normalResults];
 
     // remove duplicate search results
     // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
@@ -361,7 +398,12 @@ const Search = {
       return acc;
     }, []);
 
-    results = results.reverse();
+    return results.reverse();
+  },
+
+  query: (query) => {
+    const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
+    const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
 
     // for debugging
     //Search.lastresults = results.slice();  // a copy
@@ -466,14 +508,18 @@ const Search = {
       // add support for partial matches
       if (word.length > 2) {
         const escapedWord = _escapeRegExp(word);
-        Object.keys(terms).forEach((term) => {
-          if (term.match(escapedWord) && !terms[word])
-            arr.push({ files: terms[term], score: Scorer.partialTerm });
-        });
-        Object.keys(titleTerms).forEach((term) => {
-          if (term.match(escapedWord) && !titleTerms[word])
-            arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
-        });
+        if (!terms.hasOwnProperty(word)) {
+          Object.keys(terms).forEach((term) => {
+            if (term.match(escapedWord))
+              arr.push({ files: terms[term], score: Scorer.partialTerm });
+          });
+        }
+        if (!titleTerms.hasOwnProperty(word)) {
+          Object.keys(titleTerms).forEach((term) => {
+            if (term.match(escapedWord))
+              arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
+          });
+        }
       }
 
       // no match but word was a required one
@@ -496,9 +542,8 @@ const Search = {
 
       // create the mapping
       files.forEach((file) => {
-        if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
-          fileMap.get(file).push(word);
-        else fileMap.set(file, [word]);
+        if (!fileMap.has(file)) fileMap.set(file, [word]);
+        else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
       });
     });
 
@@ -549,8 +594,8 @@ const Search = {
    * search summary for a given text. keywords is a list
    * of stemmed words.
    */
-  makeSearchSummary: (htmlText, keywords) => {
-    const text = Search.htmlToText(htmlText);
+  makeSearchSummary: (htmlText, keywords, anchor) => {
+    const text = Search.htmlToText(htmlText, anchor);
     if (text === "") return null;
 
     const textLower = text.toLowerCase();

sphinx/themes/basic/theme.toml

@@ -0,0 +1,23 @@
+[theme]
+inherit = "none"
+stylesheets = [
+    "basic.css",
+]
+sidebars = [
+    "localtoc.html",
+    "relations.html",
+    "sourcelink.html",
+    "searchbox.html",
+]
+pygments_style = { default = "none" }
+
+[options]
+nosidebar = "false"
+sidebarwidth = "230"
+body_min_width = "360"
+body_max_width = "800"
+navigation_with_keys = "False"
+enable_search_shortcuts = "True"
+globaltoc_collapse = "true"
+globaltoc_includehidden = "false"
+globaltoc_maxdepth = ""

sphinx/themes/bizstyle/layout.html

@@ -4,7 +4,7 @@
 
     Sphinx layout template for the bizstyle theme.
 
-    :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2024 by Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {% extends "basic/layout.html" %}
@@ -14,11 +14,6 @@
     <script src="{{ pathto('_static/bizstyle.js', 1) }}"></script>
 {%- endblock %}
 
-{# doctype override #}
-{%- block doctype %}
-<!doctype html>
-{%- endblock %}
-
 {%- block extrahead %}
     <meta name="viewport" content="width=device-width,initial-scale=1.0" />
     <!--[if lt IE 9]>

sphinx/themes/bizstyle/static/bizstyle.css_t

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- business style theme.
  *
- * :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

sphinx/themes/bizstyle/static/bizstyle.js_t

@@ -6,7 +6,7 @@
 //
 // This theme was created by referring to 'sphinxdoc'
 //
-// :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS.
+// :copyright: Copyright 2007-2024 by Sphinx team, see AUTHORS.
 // :license: BSD, see LICENSE for details.
 //
 const initialiseBizStyle = () => {

sphinx/themes/bizstyle/static/css3-mediaqueries_src.js

@@ -4,15 +4,15 @@ css3-mediaqueries.js - CSS Helper and CSS3 Media Queries Enabler
 author: Wouter van der Graaf <wouter at dynora nl>
 version: 1.0 (20110330)
 license: MIT
-website: http://code.google.com/p/css3-mediaqueries-js/
+website: https://code.google.com/p/css3-mediaqueries-js/
 
-W3C spec: http://www.w3.org/TR/css3-mediaqueries/
+W3C spec: https://www.w3.org/TR/css3-mediaqueries/
 
 Note: use of embedded <style> is not recommended when using media queries, because IE  has no way of returning the raw literal css text from a <style> element.
 */
 
 
-// true prototypal inheritance (http://javascript.crockford.com/prototypal.html)
+// true prototypal inheritance (https://javascript.crockford.com/prototypal.html)
 if (typeof Object.create !== 'function') {
 	Object.create = function (o) {
 		function F() {}

sphinx/themes/bizstyle/theme.toml

@@ -0,0 +1,12 @@
+[theme]
+inherit = "basic"
+stylesheets = [
+    "bizstyle.css",
+]
+pygments_style = { default = "friendly" }
+
+[options]
+rightsidebar = "false"
+sidebarwidth = "210"
+
+maincolor = "#336699"

sphinx/themes/classic/layout.html

@@ -4,7 +4,7 @@
 
     Sphinx layout template for the classic theme.
 
-    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "basic/layout.html" %}

sphinx/themes/classic/static/classic.css_t

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- classic theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

sphinx/themes/classic/static/sidebar.js_t

@@ -16,7 +16,7 @@
  * Once the browser is closed the cookie is deleted and the position
  * reset to the default (expanded).
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

sphinx/themes/classic/theme.toml

@@ -0,0 +1,34 @@
+[theme]
+inherit = "basic"
+stylesheets = [
+    "classic.css",
+]
+pygments_style = { default = "sphinx" }
+
+[options]
+rightsidebar = "false"
+stickysidebar = "false"
+collapsiblesidebar = "false"
+externalrefs = "false"
+
+footerbgcolor    = "#11303d"
+footertextcolor  = "#ffffff"
+sidebarbgcolor   = "#1c4e63"
+sidebarbtncolor  = "#3c6e83"
+sidebartextcolor = "#ffffff"
+sidebarlinkcolor = "#98dbcc"
+relbarbgcolor    = "#133f52"
+relbartextcolor  = "#ffffff"
+relbarlinkcolor  = "#ffffff"
+bgcolor          = "#ffffff"
+textcolor        = "#000000"
+headbgcolor      = "#f2f2f2"
+headtextcolor    = "#20435c"
+headlinkcolor    = "#c60f0f"
+linkcolor        = "#355f7c"
+visitedlinkcolor = "#551a8b"
+codebgcolor      = "unset"
+codetextcolor    = "unset"
+
+bodyfont = "sans-serif"
+headfont = "'Trebuchet MS', sans-serif"

sphinx/themes/default/theme.toml

@@ -0,0 +1,2 @@
+[theme]
+inherit = "classic"

sphinx/themes/epub/epub-cover.html

@@ -4,7 +4,7 @@
 
     Sample template for the html cover page.
 
-    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "layout.html" %}

sphinx/themes/epub/layout.html

@@ -4,7 +4,7 @@
 
     Sphinx layout template for the epub theme.
 
-    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "basic/layout.html" %}

sphinx/themes/epub/static/epub.css_t

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- epub theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

sphinx/themes/epub/theme.toml

@@ -0,0 +1,10 @@
+[theme]
+inherit = "basic"
+stylesheets = [
+    "epub.css",
+]
+pygments_style = { default = "none" }
+
+[options]
+relbar1 = "true"
+footer = "true"

sphinx/themes/haiku/layout.html

@@ -4,7 +4,7 @@
 
     Sphinx layout template for the haiku theme.
 
-    :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 #}
 {%- extends "basic/layout.html" %}
@@ -35,14 +35,14 @@
       <div class="header" role="banner">
         {%- block haikuheader %}
         {%- if theme_full_logo != "false" %}
-        <a href="{{ pathto('index') }}">
+        <a href="{{ pathto(root_doc)|e }}">
           <img class="logo" src="{{ logo_url|e }}" alt="Logo"/>
         </a>
         {%- else %}
         {%- if logo -%}
           <img class="rightlogo" src="{{ logo_url|e }}" alt="Logo"/>
         {%- endif -%}
-        <h1 class="heading"><a href="{{ pathto('index') }}">
+        <h1 class="heading"><a href="{{ pathto(root_doc)|e }}">
           <span>{{ shorttitle|e }}</span></a></h1>
         <h2 class="heading"><span>{{ title|striptags|e }}</span></h2>
         {%- endif %}