deploy: isso-comments/isso@33ad1fb

isso-comments · May 5, 2024 · 26eecbe · 26eecbe
1 parent 3c4ca98
commit 26eecbe
Show file tree

Hide file tree

Showing 18 changed files with 43 additions and 43 deletions.
diff --git a/.doctrees/docs/contributing/documentation.doctree b/.doctrees/docs/contributing/documentation.doctree
diff --git a/.doctrees/docs/reference/installation.doctree b/.doctrees/docs/reference/installation.doctree
diff --git a/.doctrees/docs/technical-docs/testing-client.doctree b/.doctrees/docs/technical-docs/testing-client.doctree
diff --git a/.doctrees/docs/technical-docs/testing.doctree b/.doctrees/docs/technical-docs/testing.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/_sources/docs/contributing/documentation.rst.txt b/_sources/docs/contributing/documentation.rst.txt
@@ -50,7 +50,7 @@ Install via pip:
 
 .. code-block:: console
 
-   $ virtualenv .venv && $ source .venv/bin/activate
+   $ virtualenv --download .venv && $ source .venv/bin/activate
    (.venv) $ pip install sphinx
    (.venv) $ sphinx-build --version
    ~> sphinx-build 4.5.0
@@ -157,7 +157,7 @@ Use ``.. code-block:: <language>`` and indent the code by one level:
    .. code-block:: console
 
         $ sudo apt install python3 python3-pip python3-virtualenv
-        $ virtualenv .venv
+        $ virtualenv --download .venv
         $ source .venv/bin/activate
         (.venv) $ python [cmd]
 

diff --git a/_sources/docs/reference/installation.rst.txt b/_sources/docs/reference/installation.rst.txt
@@ -48,7 +48,7 @@ but not recommended):
 
 .. code-block:: console
 
-    $ virtualenv /opt/isso
+    $ virtualenv --download /opt/isso
     $ source /opt/isso/bin/activate
 
 .. note::
@@ -82,7 +82,7 @@ Install from PyPi
 Requirements
 ^^^^^^^^^^^^
 
-- Python 3.8+ (+ devel headers)
+- Python 3.8+ (+ devel headers) and Virtualenv
 - SQLite 3.3.8 or later
 - a working C compiler
 
@@ -91,13 +91,13 @@ For Debian/Ubuntu just `copy and paste
 
 .. code-block:: console
 
-    $ sudo apt-get install python3-dev sqlite3 build-essential
+    $ sudo apt-get install python3-dev python3-virtualenv sqlite3 build-essential
 
 Similar for Fedora (and derivates):
 
 .. code-block:: console
 
-    $ sudo yum install python3-devel sqlite
+    $ sudo yum install python3-devel python3-virtualenv sqlite
     $ sudo yum groupinstall “Development Tools”
 
 Installation
@@ -216,7 +216,7 @@ To create a virtual environment (recommended), run:
 
 .. code-block:: console
 
-    $ virtualenv .venv
+    $ virtualenv --download .venv
     $ source .venv/bin/activate
 
 Install JavaScript modules using ``npm``:
@@ -235,7 +235,7 @@ Install Isso and its dependencies:
 
 .. code-block:: console
 
-    (.venv) $ python setup.py develop  # or `pip install -e .`
+    (.venv) $ pip install -e .  # -e = "editable" installation for development
     (.venv) $ isso -c /path/to/isso.cfg run
 
 .. _init-scripts:

diff --git a/_sources/docs/technical-docs/testing-client.rst.txt b/_sources/docs/technical-docs/testing-client.rst.txt
@@ -87,7 +87,7 @@ Start the server and ensure that the comment database is empty:
 .. code-block:: bash
 
    $ mv comments.db comments.db.bak
-   $ virtualenv .venv
+   $ virtualenv --download .venv
    $ source .venv/bin/activate
    (.venv) $ isso -c contrib/isso-dev.cfg run
 

diff --git a/_sources/docs/technical-docs/testing.rst.txt b/_sources/docs/technical-docs/testing.rst.txt
@@ -37,7 +37,7 @@ a development server available at ``localhost:8080``.
 
 .. code-block:: bash
 
-   $ virtualenv .venv
+   $ virtualenv --download .venv
    $ source .venv/bin/activate
    (.venv) $ isso -c contrib/isso-dev.cfg run
 

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=1714848099681" rel="stylesheet" media="screen">
-  <link href="assets/prism.css?v=1714848099681" rel="stylesheet" />
-  <link href="assets/prism-toolbar.css?v=1714848099681" rel="stylesheet" />
-  <link href="assets/prism-diff-highlight.css?v=1714848099681" rel="stylesheet" />
-  <link href="assets/main.css?v=1714848099681" rel="stylesheet" media="screen, print">
-  <link href="assets/favicon.ico?v=1714848099681" rel="icon" type="image/x-icon">
-  <link href="assets/apple-touch-icon.png?v=1714848099681" rel="apple-touch-icon" sizes="180x180">
-  <link href="assets/favicon-32x32.png?v=1714848099681" rel="icon" type="image/png" sizes="32x32">
-  <link href="assets/favicon-16x16.png?v=1714848099681" rel="icon" type="image/png" sizes="16x16">
+  <link href="assets/bootstrap.min.css?v=1714944866151" rel="stylesheet" media="screen">
+  <link href="assets/prism.css?v=1714944866151" rel="stylesheet" />
+  <link href="assets/prism-toolbar.css?v=1714944866151" rel="stylesheet" />
+  <link href="assets/prism-diff-highlight.css?v=1714944866151" rel="stylesheet" />
+  <link href="assets/main.css?v=1714944866151" rel="stylesheet" media="screen, print">
+  <link href="assets/favicon.ico?v=1714944866151" rel="icon" type="image/x-icon">
+  <link href="assets/apple-touch-icon.png?v=1714944866151" rel="apple-touch-icon" sizes="180x180">
+  <link href="assets/favicon-32x32.png?v=1714944866151" rel="icon" type="image/png" sizes="32x32">
+  <link href="assets/favicon-16x16.png?v=1714944866151" 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=1714848099681"></script>
+<script src="assets/main.bundle.js?v=1714944866151"></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=1714848099681" rel="stylesheet" media="screen">
-  <link href="assets/prism.css?v=1714848099681" rel="stylesheet" />
-  <link href="assets/prism-toolbar.css?v=1714848099681" rel="stylesheet" />
-  <link href="assets/prism-diff-highlight.css?v=1714848099681" rel="stylesheet" />
-  <link href="assets/main.css?v=1714848099681" rel="stylesheet" media="screen, print">
-  <link href="assets/favicon.ico?v=1714848099681" rel="icon" type="image/x-icon">
-  <link href="assets/apple-touch-icon.png?v=1714848099681" rel="apple-touch-icon" sizes="180x180">
-  <link href="assets/favicon-32x32.png?v=1714848099681" rel="icon" type="image/png" sizes="32x32">
-  <link href="assets/favicon-16x16.png?v=1714848099681" rel="icon" type="image/png" sizes="16x16">
+  <link href="assets/bootstrap.min.css?v=1714944866151" rel="stylesheet" media="screen">
+  <link href="assets/prism.css?v=1714944866151" rel="stylesheet" />
+  <link href="assets/prism-toolbar.css?v=1714944866151" rel="stylesheet" />
+  <link href="assets/prism-diff-highlight.css?v=1714944866151" rel="stylesheet" />
+  <link href="assets/main.css?v=1714944866151" rel="stylesheet" media="screen, print">
+  <link href="assets/favicon.ico?v=1714944866151" rel="icon" type="image/x-icon">
+  <link href="assets/apple-touch-icon.png?v=1714944866151" rel="apple-touch-icon" sizes="180x180">
+  <link href="assets/favicon-32x32.png?v=1714944866151" rel="icon" type="image/png" sizes="32x32">
+  <link href="assets/favicon-16x16.png?v=1714944866151" 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=1714848099681"></script>
+<script src="assets/main.bundle.js?v=1714944866151"></script>
 </body>
 </html>
diff --git a/docs/contributing/documentation/index.html b/docs/contributing/documentation/index.html
@@ -163,7 +163,7 @@ <h3><a class="toc-backref" href="#id8" role="doc-backlink">Building the docs</a>
 docs need <strong>at least Sphinx version 4.5.0</strong>.</p>
 </div>
 <p>Install via pip:</p>
-<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>virtualenv<span class="w"> </span>.venv<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>$<span class="w"> </span><span class="nb">source</span><span class="w"> </span>.venv/bin/activate
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>virtualenv<span class="w"> </span>--download<span class="w"> </span>.venv<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>$<span class="w"> </span><span class="nb">source</span><span class="w"> </span>.venv/bin/activate
 <span class="gp gp-VirtualEnv">(.venv)</span> <span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>sphinx
 <span class="gp gp-VirtualEnv">(.venv)</span> <span class="gp">$ </span>sphinx-build<span class="w"> </span>--version
 <span class="go">~&gt; sphinx-build 4.5.0</span>
@@ -241,7 +241,7 @@ <h3><a class="toc-backref" href="#id10" role="doc-backlink">How to write reST</a
 <div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">code-block</span><span class="p">::</span> <span class="k">console</span>
 
      <span class="gp">$ </span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>python3<span class="w"> </span>python3-pip<span class="w"> </span>python3-virtualenv
-     <span class="gp">$ </span>virtualenv<span class="w"> </span>.venv
+     <span class="gp">$ </span>virtualenv<span class="w"> </span>--download<span class="w"> </span>.venv
      <span class="gp">$ </span><span class="nb">source</span><span class="w"> </span>.venv/bin/activate
      <span class="gp gp-VirtualEnv">(.venv)</span> <span class="gp">$ </span>python<span class="w"> </span><span class="o">[</span>cmd<span class="o">]</span>
 </pre></div>

diff --git a/docs/reference/installation/index.html b/docs/reference/installation/index.html
@@ -152,7 +152,7 @@ <h2>Installation<a class="headerlink" href="#installation" title="Link to this h
 </div>
 <p>The next steps should be done as regular user, not as root (although possible
 but not recommended):</p>
-<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>virtualenv<span class="w"> </span>/opt/isso
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>virtualenv<span class="w"> </span>--download<span class="w"> </span>/opt/isso
 <span class="gp">$ </span><span class="nb">source</span><span class="w"> </span>/opt/isso/bin/activate
 </pre></div>
 </div>
@@ -179,16 +179,16 @@ <h2>Installation<a class="headerlink" href="#installation" title="Link to this h
 <section id="requirements">
 <h4>Requirements<a class="headerlink" href="#requirements" title="Link to this heading">¶</a></h4>
 <ul class="simple">
-<li><p>Python 3.8+ (+ devel headers)</p></li>
+<li><p>Python 3.8+ (+ devel headers) and Virtualenv</p></li>
 <li><p>SQLite 3.3.8 or later</p></li>
 <li><p>a working C compiler</p></li>
 </ul>
 <p>For Debian/Ubuntu just <a class="reference external" href="http://thejh.net/misc/website-terminal-copy-paste">copy and paste</a> to your terminal:</p>
-<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>python3-dev<span class="w"> </span>sqlite3<span class="w"> </span>build-essential
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>python3-dev<span class="w"> </span>python3-virtualenv<span class="w"> </span>sqlite3<span class="w"> </span>build-essential
 </pre></div>
 </div>
 <p>Similar for Fedora (and derivates):</p>
-<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span>python3-devel<span class="w"> </span>sqlite
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span>python3-devel<span class="w"> </span>python3-virtualenv<span class="w"> </span>sqlite
 <span class="gp">$ </span>sudo<span class="w"> </span>yum<span class="w"> </span>groupinstall<span class="w"> </span>“Development<span class="w"> </span>Tools”
 </pre></div>
 </div>
@@ -279,7 +279,7 @@ <h4>b) Build a Docker image yourself<a class="headerlink" href="#b-build-a-docke
 </pre></div>
 </div>
 <p>To create a virtual environment (recommended), run:</p>
-<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>virtualenv<span class="w"> </span>.venv
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>virtualenv<span class="w"> </span>--download<span class="w"> </span>.venv
 <span class="gp">$ </span><span class="nb">source</span><span class="w"> </span>.venv/bin/activate
 </pre></div>
 </div>
@@ -292,7 +292,7 @@ <h4>b) Build a Docker image yourself<a class="headerlink" href="#b-build-a-docke
 </pre></div>
 </div>
 <p>Install Isso and its dependencies:</p>
-<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp gp-VirtualEnv">(.venv)</span> <span class="gp">$ </span>python<span class="w"> </span>setup.py<span class="w"> </span>develop<span class="w">  </span><span class="c1"># or `pip install -e .`</span>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp gp-VirtualEnv">(.venv)</span> <span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.<span class="w">  </span><span class="c1"># -e = &quot;editable&quot; installation for development</span>
 <span class="gp gp-VirtualEnv">(.venv)</span> <span class="gp">$ </span>isso<span class="w"> </span>-c<span class="w"> </span>/path/to/isso.cfg<span class="w"> </span>run
 </pre></div>
 </div>

diff --git a/docs/technical-docs/testing-client/index.html b/docs/technical-docs/testing-client/index.html
@@ -192,7 +192,7 @@ <h3><a class="toc-backref" href="#id6" role="doc-backlink">End-to-End Integratio
 </div>
 <p>Start the server and ensure that the comment database is empty:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mv<span class="w"> </span>comments.db<span class="w"> </span>comments.db.bak
-$<span class="w"> </span>virtualenv<span class="w"> </span>.venv
+$<span class="w"> </span>virtualenv<span class="w"> </span>--download<span class="w"> </span>.venv
 $<span class="w"> </span><span class="nb">source</span><span class="w"> </span>.venv/bin/activate
 <span class="o">(</span>.venv<span class="o">)</span><span class="w"> </span>$<span class="w"> </span>isso<span class="w"> </span>-c<span class="w"> </span>contrib/isso-dev.cfg<span class="w"> </span>run
 </pre></div>

diff --git a/docs/technical-docs/testing/index.html b/docs/technical-docs/testing/index.html
@@ -151,7 +151,7 @@ <h2>Development &amp; Testing<a class="headerlink" href="#development-testing" t
 <span id="id1"></span><h3><a class="toc-backref" href="#id2" role="doc-backlink">Development server</a><a class="headerlink" href="#development-server" title="Link to this heading">¶</a></h3>
 <p>After you’ve set up Isso according to <a class="reference internal" href="../../reference/installation/#install-from-source"><span class="std std-ref">Install from Source</span></a>, you will have
 a development server available at <code class="docutils literal notranslate"><span class="pre">localhost:8080</span></code>.</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>virtualenv<span class="w"> </span>.venv
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>virtualenv<span class="w"> </span>--download<span class="w"> </span>.venv
 $<span class="w"> </span><span class="nb">source</span><span class="w"> </span>.venv/bin/activate
 <span class="o">(</span>.venv<span class="o">)</span><span class="w"> </span>$<span class="w"> </span>isso<span class="w"> </span>-c<span class="w"> </span>contrib/isso-dev.cfg<span class="w"> </span>run
 </pre></div>

diff --git a/searchindex.js b/searchindex.js