deploy: isso-comments/isso@a5514d7

isso-comments · Oct 31, 2023 · c97f1c9 · c97f1c9
1 parent b860204
commit c97f1c9
Show file tree

Hide file tree

Showing 40 changed files with 278 additions and 257 deletions.
diff --git a/.doctrees/docs/reference/installation.doctree b/.doctrees/docs/reference/installation.doctree
diff --git a/.doctrees/docs/reference/server-api.doctree b/.doctrees/docs/reference/server-api.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/_sources/docs/reference/installation.rst.txt b/_sources/docs/reference/installation.rst.txt
@@ -82,7 +82,7 @@ Install from PyPi
 Requirements
 ^^^^^^^^^^^^
 
-- Python 3.7+ (+ devel headers)
+- Python 3.8+ (+ devel headers)
 - SQLite 3.3.8 or later
 - a working C compiler
 
@@ -181,7 +181,7 @@ Install from Source
 If you want to hack on Isso or track down issues, there's an alternate
 way to set up Isso. It requires a lot more dependencies and effort:
 
-- Python 3.7+ (+ devel headers)
+- Python 3.8+ (+ devel headers)
 - Virtualenv
 - SQLite 3.3.8 or later
 - a working C compiler (e.g. the ``gcc`` package)

diff --git a/_static/basic.css b/_static/basic.css
@@ -237,6 +237,10 @@ a.headerlink {
     visibility: hidden;
 }
 
+a:visited {
+    color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,4 @@
-var DOCUMENTATION_OPTIONS = {
-    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+const DOCUMENTATION_OPTIONS = {
     VERSION: '',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,

diff --git a/_static/searchtools.js b/_static/searchtools.js
@@ -57,12 +57,12 @@ const _removeChildren = (element) => {
 const _escapeRegExp = (string) =>
   string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
 
-const _displayItem = (item, searchTerms) => {
+const _displayItem = (item, searchTerms, highlightTerms) => {
   const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
-  const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
   const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
   const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
   const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+  const contentRoot = document.documentElement.dataset.content_root;
 
   const [docName, title, anchor, descr, score, _filename] = item;
 
@@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => {
     if (dirname.match(/\/index\/$/))
       dirname = dirname.substring(0, dirname.length - 6);
     else if (dirname === "index/") dirname = "";
-    requestUrl = docUrlRoot + dirname;
+    requestUrl = contentRoot + dirname;
     linkUrl = requestUrl;
   } else {
     // normal html builders
-    requestUrl = docUrlRoot + docName + docFileSuffix;
+    requestUrl = contentRoot + docName + docFileSuffix;
     linkUrl = docName + docLinkSuffix;
   }
   let linkEl = listItem.appendChild(document.createElement("a"));
   linkEl.href = linkUrl + anchor;
   linkEl.dataset.score = score;
   linkEl.innerHTML = title;
-  if (descr)
+  if (descr) {
     listItem.appendChild(document.createElement("span")).innerHTML =
       " (" + descr + ")";
+    // highlight search terms in the description
+    if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
+      highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+  }
   else if (showSearchSummary)
     fetch(requestUrl)
       .then((responseData) => responseData.text())
@@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => {
           listItem.appendChild(
             Search.makeSearchSummary(data, searchTerms)
           );
+        // highlight search terms in the summary
+        if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
+          highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
       });
   Search.output.appendChild(listItem);
 };
@@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => {
 const _displayNextItem = (
   results,
   resultCount,
-  searchTerms
+  searchTerms,
+  highlightTerms,
 ) => {
   // results left, load the summary and display it
   // this is intended to be dynamic (don't sub resultsCount)
   if (results.length) {
-    _displayItem(results.pop(), searchTerms);
+    _displayItem(results.pop(), searchTerms, highlightTerms);
     setTimeout(
-      () => _displayNextItem(results, resultCount, searchTerms),
+      () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
       5
     );
   }
@@ -360,7 +368,7 @@ const Search = {
     // console.info("search results:", Search.lastresults);
 
     // print the results
-    _displayNextItem(results, results.length, searchTerms);
+    _displayNextItem(results, results.length, searchTerms, highlightTerms);
   },
 
   /**

diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js
@@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => {
       }
 
       span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+      const rest = document.createTextNode(val.substr(pos + text.length));
       parent.insertBefore(
         span,
         parent.insertBefore(
-          document.createTextNode(val.substr(pos + text.length)),
+          rest,
           node.nextSibling
         )
       );
       node.nodeValue = val.substr(0, pos);
+      /* There may be more occurrences of search term in this node. So call this
+       * function recursively on the remaining fragment.
+       */
+      _highlight(rest, addItems, text, className);
 
       if (isInSVG) {
         const rect = document.createElementNS(
@@ -140,5 +145,10 @@ const SphinxHighlight = {
   },
 };
 
-_ready(SphinxHighlight.highlightSearchWords);
-_ready(SphinxHighlight.initEscapeListener);
+_ready(() => {
+  /* Do not call highlightSearchWords() when we are on the search page.
+   * It will highlight words from the *previous* search query.
+   */
+  if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
+  SphinxHighlight.initEscapeListener();
+});
diff --git a/community/index.html b/community/index.html
@@ -9,9 +9,9 @@
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=983eb2ed" />
     <link rel="stylesheet" type="text/css" href="../_static/css/site.css?v=decc2ba4" />
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=df4b10f6"></script>
+    <script src="../_static/documentation_options.js?v=187304be"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
-    <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="search" title="Search" href="../search/" />
     <link rel="top" title="Isso  documentation" href="../" />
 </head>
@@ -55,9 +55,9 @@ <h2>a commenting server similar to Disqus</h2>
                 <div role="main">
 
                 <section id="community">
-<h2>Community<a class="headerlink" href="#community" title="Permalink to this heading">¶</a></h2>
+<h2>Community<a class="headerlink" href="#community" title="Link to this heading">¶</a></h2>
 <section id="getting-in-contact">
-<span id="contact"></span><h3>Getting in contact<a class="headerlink" href="#getting-in-contact" title="Permalink to this heading">¶</a></h3>
+<span id="contact"></span><h3>Getting in contact<a class="headerlink" href="#getting-in-contact" title="Link to this heading">¶</a></h3>
 <p>The main place of interaction for the Isso community is the
 <a class="reference external" href="https://github.com/posativ/isso/issues">GitHub issue tracker</a>.</p>
 <p>A few people - including the lead developers and maintainers - frequent the
@@ -68,7 +68,7 @@ <h2>Community<a class="headerlink" href="#community" title="Permalink to this he
 <a class="reference external" href="https://github.com/posativ/isso/discussions">GitHub Discussions</a>.</p>
 </section>
 <section id="scripts-helpers">
-<span id="scripts-and-helpers"></span><h3>Scripts &amp; Helpers<a class="headerlink" href="#scripts-helpers" title="Permalink to this heading">¶</a></h3>
+<span id="scripts-and-helpers"></span><h3>Scripts &amp; Helpers<a class="headerlink" href="#scripts-helpers" title="Link to this heading">¶</a></h3>
 <p>Some utility scripts have been developed by isso users.
 They are stored in the <a class="reference external" href="https://github.com/posativ/isso/tree/master/contrib">GitHub contrib/ directory</a> :</p>
 <ul class="simple">
@@ -77,13 +77,13 @@ <h2>Community<a class="headerlink" href="#community" title="Permalink to this he
 </ul>
 </section>
 <section id="powered-by-isso">
-<span id="id1"></span><h3>Powered by Isso<a class="headerlink" href="#powered-by-isso" title="Permalink to this heading">¶</a></h3>
+<span id="id1"></span><h3>Powered by Isso<a class="headerlink" href="#powered-by-isso" title="Link to this heading">¶</a></h3>
 <p>A list of websites and people that use Isso can be found at
 <a class="reference external" href="https://github.com/posativ/isso/wiki/Powered-by-isso">the wiki at GitHub</a>.</p>
 <p>Feel free to add your own project to the list!</p>
 </section>
 <section id="tutorials-and-articles-about-isso">
-<span id="adjacent-projects"></span><h3>Tutorials and articles about Isso<a class="headerlink" href="#tutorials-and-articles-about-isso" title="Permalink to this heading">¶</a></h3>
+<span id="adjacent-projects"></span><h3>Tutorials and articles about Isso<a class="headerlink" href="#tutorials-and-articles-about-isso" title="Link to this heading">¶</a></h3>
 <p><em>These articles also provide concrete examples of using Isso with blog engines
 like Hugo, Ghost or Pelican.</em></p>
 <ul class="simple">
@@ -98,7 +98,7 @@ <h2>Community<a class="headerlink" href="#community" title="Permalink to this he
 </ul>
 </section>
 <section id="isso-adjacent-projects">
-<h3>Isso-adjacent Projects<a class="headerlink" href="#isso-adjacent-projects" title="Permalink to this heading">¶</a></h3>
+<h3>Isso-adjacent Projects<a class="headerlink" href="#isso-adjacent-projects" title="Link to this heading">¶</a></h3>
 <ul class="simple">
 <li><p>A Webmention receiver and publisher, has a plugin to integrate with Isso: <a class="reference external" href="https://gitlab.com/mardy/bussator">Bussator</a></p></li>
 <li><p>A plugin for <a class="reference external" href="https://en.wikipedia.org/wiki/Grav_(CMS)">Grav CMS</a> to integrate isso comments: <a class="reference external" href="https://github.com/Sommerregen/grav-plugin-jscomments&gt;">grav-plugin-jscomments</a></p></li>
@@ -116,7 +116,7 @@ <h3>Isso-adjacent Projects<a class="headerlink" href="#isso-adjacent-projects" t
 </div>
 </section>
 <section id="other-options">
-<h3>Other options<a class="headerlink" href="#other-options" title="Permalink to this heading">¶</a></h3>
+<h3>Other options<a class="headerlink" href="#other-options" title="Link to this heading">¶</a></h3>
 <p>Isso is not the only open-source commenting server. You can find an overview at
 <a class="reference external" href="https://lisakov.com/projects/open-source-comments/">lisakov.com: Open source comments</a>.</p>
 <p>Some popular options are:</p>

diff --git a/docs/api/_output/assets/main.bundle.js b/docs/api/_output/assets/main.bundle.js
diff --git a/docs/api/_output/index.html b/docs/api/_output/index.html
@@ -5,15 +5,15 @@
   <meta name="description" content="Isso API">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-  <link href="assets/bootstrap.min.css?v=1691154181409" rel="stylesheet" media="screen">
-  <link href="assets/prism.css?v=1691154181409" rel="stylesheet" />
-  <link href="assets/prism-toolbar.css?v=1691154181409" rel="stylesheet" />
-  <link href="assets/prism-diff-highlight.css?v=1691154181409" rel="stylesheet" />
-  <link href="assets/main.css?v=1691154181409" rel="stylesheet" media="screen, print">
-  <link href="assets/favicon.ico?v=1691154181409" rel="icon" type="image/x-icon">
-  <link href="assets/apple-touch-icon.png?v=1691154181409" rel="apple-touch-icon" sizes="180x180">
-  <link href="assets/favicon-32x32.png?v=1691154181409" rel="icon" type="image/png" sizes="32x32">
-  <link href="assets/favicon-16x16.png?v=1691154181409" rel="icon" type="image/png" sizes="16x16">
+  <link href="assets/bootstrap.min.css?v=1698768730509" rel="stylesheet" media="screen">
+  <link href="assets/prism.css?v=1698768730509" rel="stylesheet" />
+  <link href="assets/prism-toolbar.css?v=1698768730509" rel="stylesheet" />
+  <link href="assets/prism-diff-highlight.css?v=1698768730509" rel="stylesheet" />
+  <link href="assets/main.css?v=1698768730509" rel="stylesheet" media="screen, print">
+  <link href="assets/favicon.ico?v=1698768730509" rel="icon" type="image/x-icon">
+  <link href="assets/apple-touch-icon.png?v=1698768730509" rel="apple-touch-icon" sizes="180x180">
+  <link href="assets/favicon-32x32.png?v=1698768730509" rel="icon" type="image/png" sizes="32x32">
+  <link href="assets/favicon-16x16.png?v=1698768730509" rel="icon" type="image/png" sizes="16x16">
 </head>
 
 <body class="container-fluid">
@@ -1042,6 +1042,6 @@ <h2>{{__ "Request Body"}}</h2>
   </div>
 </div>
 
-<script src="assets/main.bundle.js?v=1691154181409"></script>
+<script src="assets/main.bundle.js?v=1698768730509"></script>
 </body>
 </html>
diff --git a/docs/api/assets/main.bundle.js b/docs/api/assets/main.bundle.js
diff --git a/docs/api/index.html b/docs/api/index.html
@@ -5,15 +5,15 @@
   <meta name="description" content="Isso API">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-  <link href="assets/bootstrap.min.css?v=1691154181409" rel="stylesheet" media="screen">
-  <link href="assets/prism.css?v=1691154181409" rel="stylesheet" />
-  <link href="assets/prism-toolbar.css?v=1691154181409" rel="stylesheet" />
-  <link href="assets/prism-diff-highlight.css?v=1691154181409" rel="stylesheet" />
-  <link href="assets/main.css?v=1691154181409" rel="stylesheet" media="screen, print">
-  <link href="assets/favicon.ico?v=1691154181409" rel="icon" type="image/x-icon">
-  <link href="assets/apple-touch-icon.png?v=1691154181409" rel="apple-touch-icon" sizes="180x180">
-  <link href="assets/favicon-32x32.png?v=1691154181409" rel="icon" type="image/png" sizes="32x32">
-  <link href="assets/favicon-16x16.png?v=1691154181409" rel="icon" type="image/png" sizes="16x16">
+  <link href="assets/bootstrap.min.css?v=1698768730509" rel="stylesheet" media="screen">
+  <link href="assets/prism.css?v=1698768730509" rel="stylesheet" />
+  <link href="assets/prism-toolbar.css?v=1698768730509" rel="stylesheet" />
+  <link href="assets/prism-diff-highlight.css?v=1698768730509" rel="stylesheet" />
+  <link href="assets/main.css?v=1698768730509" rel="stylesheet" media="screen, print">
+  <link href="assets/favicon.ico?v=1698768730509" rel="icon" type="image/x-icon">
+  <link href="assets/apple-touch-icon.png?v=1698768730509" rel="apple-touch-icon" sizes="180x180">
+  <link href="assets/favicon-32x32.png?v=1698768730509" rel="icon" type="image/png" sizes="32x32">
+  <link href="assets/favicon-16x16.png?v=1698768730509" rel="icon" type="image/png" sizes="16x16">
 </head>
 
 <body class="container-fluid">
@@ -1042,6 +1042,6 @@ <h2>{{__ "Request Body"}}</h2>
   </div>
 </div>
 
-<script src="assets/main.bundle.js?v=1691154181409"></script>
+<script src="assets/main.bundle.js?v=1698768730509"></script>
 </body>
 </html>