From 57275fb88440d6cb23d553dacc186396c9c0bcf8 Mon Sep 17 00:00:00 2001
From: Manuel Mendez <github@i.m.mmlb.dev>
Date: Thu, 5 Dec 2024 12:37:08 -0500
Subject: [PATCH 1/5] Fix incorrect html in index.html

Found using superhtml:
```
$ superhtml check doc/_templates/index.html
doc/_templates/index.html:5:3: html_elements_cant_self_close
doc/_templates/index.html:37:72: erroneous_end_tag
doc/_templates/index.html:38:76: missing_end_tag
doc/_templates/index.html:38:30: missing_end_tag
```

Signed-off-by: Manuel Mendez <github@i.m.mmlb.dev>
---
 doc/_templates/index.html | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index 59aad80c..74d49d37 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -4,7 +4,7 @@
 <h1>Welcome to the home of Flent</h1>
 <div class="screenshot">
   <img src="_static/flent-screenshot.png" alt="Screenshot of the interactive
-  Flent GUI." />
+  Flent GUI.">
 </div>
 <p>Flent is a network benchmarking tool which allows you to:</p>
 <ul class="front">
@@ -35,8 +35,8 @@ <h1>Welcome to the home of Flent</h1>
 
 <h2>Getting started</h2>
 <p>Install Flent as per the instructions below, then see <a
-href="intro.html#quick-start">the Quick-start section</a> to get going</a>.</p>
-<p>For more information, see <a href="contents.html">the full documentation<a>
+href="intro.html#quick-start">the Quick-start section</a> to get going.</p>
+<p>For more information, see <a href="contents.html">the full documentation</a>
 or <a href="search.html">search</a> for specific content.</p>
 <h2>Installing Flent</h2>
 <p>Installing Flent can be done in several ways, depending on your operating system:</p>

From c647d07e2777f9bc76218e0bf41d939c8ee2997b Mon Sep 17 00:00:00 2001
From: Manuel Mendez <github@i.m.mmlb.dev>
Date: Thu, 5 Dec 2024 13:40:45 -0500
Subject: [PATCH 2/5] Fix D-ITG sub-section case consistency

Other sub-sections have Sentence case, this was the only one with
initial caps.

Signed-off-by: Manuel Mendez <github@i.m.mmlb.dev>
---
 doc/misc.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/misc.rst b/doc/misc.rst
index 897d2632..9d175989 100644
--- a/doc/misc.rst
+++ b/doc/misc.rst
@@ -1,7 +1,7 @@
 Misc info
 =========
 
-Running Tests With The D-ITG Tool
+Running tests with the D-ITG tool
 ---------------------------------
 
 This version of flent has experimental support for running and parsing the

From a6252c36a6f3199377ba3a62758c64fdc057884f Mon Sep 17 00:00:00 2001
From: Manuel Mendez <github@i.m.mmlb.dev>
Date: Thu, 5 Dec 2024 12:08:50 -0500
Subject: [PATCH 3/5] Sync install docs content

README was missing Gentoo. Moved Arch linux up so the almost
alphabetically sorted linux distros would in fact be sorted.

I split OSX from "Other Linux" in index.html to match the other files. I
changed the content to point to intro.html#installing-flent as it wasn't
a one/two liner like the others so seemed to be better off as a link.

Signed-off-by: Manuel Mendez <github@i.m.mmlb.dev>
---
 README.rst                | 14 ++++++++++----
 doc/_templates/index.html |  7 ++++---
 doc/quickstart.rst        |  8 ++++----
 3 files changed, 18 insertions(+), 11 deletions(-)

diff --git a/README.rst b/README.rst
index 0b6a48bb..370bc5c6 100644
--- a/README.rst
+++ b/README.rst
@@ -11,6 +11,10 @@ Installing Flent
 Installing Flent can be done in several ways, depending on your operating system:
 
 
+- **Arch Linux:**
+
+  Install Flent from `the AUR <https://aur.archlinux.org/packages/flent>`_.
+
 - **Debian and Ubuntu:**
 
     .. code-block:: bash
@@ -23,13 +27,15 @@ Installing Flent can be done in several ways, depending on your operating system
 
       dnf install flent
 
-- **Ubuntu pre-18.04:**
+- **Gentoo:**
 
-  Add the `tohojo/flent PPA <https://launchpad.net/~tohojo/+archive/ubuntu/flent>`_.
+    .. code-block:: bash
 
-- **Arch Linux:**
+      emerge net-analyzer/flent
 
-  Install Flent from `the AUR <https://aur.archlinux.org/packages/flent>`_.
+- **Ubuntu pre-18.04:**
+
+  Add the `tohojo/flent PPA <https://launchpad.net/~tohojo/+archive/ubuntu/flent>`_.
 
 - **Other Linux:**
 
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index 74d49d37..bbee773e 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -41,6 +41,7 @@ <h2>Getting started</h2>
 <h2>Installing Flent</h2>
 <p>Installing Flent can be done in several ways, depending on your operating system:</p>
 <ul>
+  <li><strong>Arch Linux:</strong> Install Flent from <a href="https://aur.archlinux.org/packages/flent">the AUR</a>.</li>
   <li><strong>Debian and Ubuntu:</strong> <code class="docutils
   literal"><span class="pre">apt install flent</span></code>. To install
   netperf, <a href="https://wiki.debian.org/SourcesList">enable the non-free repository</a>.</li>
@@ -48,10 +49,10 @@ <h2>Installing Flent</h2>
   <li><strong>Gentoo:</strong> <code class="docutils literal"><span class="pre">emerge net-analyzer/flent</span></code>.</li>
   <li><strong>Ubuntu pre-18.04:</strong> Add the <a
   href="https://launchpad.net/~tohojo/+archive/ubuntu/flent">tohojo/flent PPA</a>.</li>
-  <li><strong>Arch Linux:</strong> Install Flent from <a href="https://aur.archlinux.org/packages/flent">the AUR</a>.</li>
-  <li><strong>FreeBSD:</strong> <code class="docutils literal"><span class="pre">pkg install flent</span></code> to install the package or <code class="docutils literal"><span class="pre">cd /usr/ports/net/flent</span></code> to install the port.</li>
-  <li><strong>Other Linux and OSX with Macbrew:</strong> Install from the <a href="https://pypi.python.org/pypi/flent">Python
+  <li><strong>Other Linux</strong> Install from the <a href="https://pypi.python.org/pypi/flent">Python
   Package Index</a>: <code class="docutils literal"><span class="pre">pip install flent</span></code></li>
+  <li><strong>FreeBSD:</strong> <code class="docutils literal"><span class="pre">pkg install flent</span></code> to install the package or <code class="docutils literal"><span class="pre">cd /usr/ports/net/flent</span></code> to install the port.</li>
+  <li><strong>OSX with Macbrew:</strong> See install instructions in the <a href="intro.html#installing-flent">Installing flent</a> section</li>
 </ul>
 <h2>Get involved</h2>
 <p>Getting involved is easy:</p>
diff --git a/doc/quickstart.rst b/doc/quickstart.rst
index c7dd54f5..10c0e2e3 100644
--- a/doc/quickstart.rst
+++ b/doc/quickstart.rst
@@ -3,6 +3,10 @@ Installing Flent
 Installing Flent can be done in several ways, depending on your operating system:
 
 
+- **Arch Linux:**
+
+  Install Flent from `the AUR <https://aur.archlinux.org/packages/flent>`_.
+
 - **Debian and Ubuntu:**
 
     .. code-block:: bash
@@ -25,10 +29,6 @@ Installing Flent can be done in several ways, depending on your operating system
 
   Add the `tohojo/flent PPA <https://launchpad.net/~tohojo/+archive/ubuntu/flent>`_.
 
-- **Arch Linux:**
-
-  Install Flent from `the AUR <https://aur.archlinux.org/packages/flent>`_.
-
 - **Other Linux:**
 
   Install from the `Python Package Index <https://pypi.python.org/pypi/flent>`_:

From 5a5bc3b3ba7cde6147bc251190fa550fcda4665c Mon Sep 17 00:00:00 2001
From: Manuel Mendez <github@i.m.mmlb.dev>
Date: Thu, 5 Dec 2024 13:54:42 -0500
Subject: [PATCH 4/5] Add nix installation instructions.

Signed-off-by: Manuel Mendez <github@i.m.mmlb.dev>
---
 README.rst                | 4 ++++
 doc/_templates/index.html | 1 +
 doc/quickstart.rst        | 4 ++++
 3 files changed, 9 insertions(+)

diff --git a/README.rst b/README.rst
index 370bc5c6..b64c63f7 100644
--- a/README.rst
+++ b/README.rst
@@ -33,6 +33,10 @@ Installing Flent can be done in several ways, depending on your operating system
 
       emerge net-analyzer/flent
 
+- **Nix:**
+
+  Flent is available in nixpkgs through the `flent` attribute.
+
 - **Ubuntu pre-18.04:**
 
   Add the `tohojo/flent PPA <https://launchpad.net/~tohojo/+archive/ubuntu/flent>`_.
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index bbee773e..90fad12f 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -47,6 +47,7 @@ <h2>Installing Flent</h2>
   netperf, <a href="https://wiki.debian.org/SourcesList">enable the non-free repository</a>.</li>
   <li><strong>Fedora:</strong> <code class="docutils literal"><span class="pre">dnf install flent</span></code>.</li>
   <li><strong>Gentoo:</strong> <code class="docutils literal"><span class="pre">emerge net-analyzer/flent</span></code>.</li>
+  <li><strong>Nix:</strong> Flent is available in nixpkgs through the <code class="docutils literal"><span class="pre">flent</span></code> attribute.</li>
   <li><strong>Ubuntu pre-18.04:</strong> Add the <a
   href="https://launchpad.net/~tohojo/+archive/ubuntu/flent">tohojo/flent PPA</a>.</li>
   <li><strong>Other Linux</strong> Install from the <a href="https://pypi.python.org/pypi/flent">Python
diff --git a/doc/quickstart.rst b/doc/quickstart.rst
index 10c0e2e3..b3d37849 100644
--- a/doc/quickstart.rst
+++ b/doc/quickstart.rst
@@ -25,6 +25,10 @@ Installing Flent can be done in several ways, depending on your operating system
 
       emerge net-analyzer/flent
 
+- **Nix:**
+
+  Flent is available in nixpkgs through the `flent` attribute.
+
 - **Ubuntu pre-18.04:**
 
   Add the `tohojo/flent PPA <https://launchpad.net/~tohojo/+archive/ubuntu/flent>`_.

From db6882f799603f9adf486a202ee61650ef6d36b8 Mon Sep 17 00:00:00 2001
From: Manuel Mendez <github@i.m.mmlb.dev>
Date: Fri, 6 Dec 2024 09:45:13 -0500
Subject: [PATCH 5/5] Reformat html templates

Originally tried with prettier but I think superhtml's output is nicer.

Signed-off-by: Manuel Mendez <github@i.m.mmlb.dev>
---
 doc/_templates/index.html | 112 +++++++++++++++++++++++---------------
 1 file changed, 67 insertions(+), 45 deletions(-)

diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index 90fad12f..39527c05 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -3,63 +3,85 @@
 {% block body %}
 <h1>Welcome to the home of Flent</h1>
 <div class="screenshot">
-  <img src="_static/flent-screenshot.png" alt="Screenshot of the interactive
-  Flent GUI.">
+  <img src="_static/flent-screenshot.png" alt="Screenshot of the interactive Flent GUI.">
 </div>
 <p>Flent is a network benchmarking tool which allows you to:</p>
 <ul class="front">
-  <li>Easily <strong>run network tests</strong> composing multiple well-known benchmarking tools into
-    aggregate, repeatable test runs.</li>
-  <li><strong>Explore</strong> your test data through the interactive GUI and extensive plotting
-    capabilities.</li>
-  <li><strong>Combine and aggregate</strong> data series and produce publication quality graphs.</li>
-  <li><strong>Capture metadata</strong> from local and remote hosts and store it along with the
-    plot data.</li>
-  <li><strong>Collect secondary data series</strong> such as CPU usage, WiFi, qdisc and TCP socket
-    statistics and plot it with the main dataset.</li>
-  <li>Specify batch experiment runs to <strong>completely automate your
-  testing</strong> regime.</li>
+  <li>Easily
+    <strong>run network tests</strong>
+    composing multiple well-known benchmarking tools into aggregate, repeatable test runs.</li>
+  <li><strong>Explore</strong>
+    your test data through the interactive GUI and extensive plotting capabilities.</li>
+  <li><strong>Combine and aggregate</strong>
+    data series and produce publication quality graphs.</li>
+  <li><strong>Capture metadata</strong>
+    from local and remote hosts and store it along with the plot data.</li>
+  <li><strong>Collect secondary data series</strong>
+    such as CPU usage, WiFi, qdisc and TCP socket statistics and plot it with the main dataset.</li>
+  <li>Specify batch experiment runs to
+    <strong>completely automate your testing</strong>
+    regime.</li>
 </ul>
-
 <div style="clear: both;"></div>
-<p>Flent is written in Python and wraps well-known network benchmarking tools
-  (such as <a href="http://netperf.org">netperf</a>
-  and <a href="https://sourceforge.net/p/iperf2">iperf</a>) into aggregate,
-  repeatable tests, such as a number
-  of <a href="https://www.bufferbloat.net/projects/bloat/wiki/Tests_for_Bufferbloat/">tests
-  for Bufferbloat</a>.</p>
-<p>There's a <a href="flent-the-flexible-network-tester.pdf">short paper
-  (pdf)</a> and
-  a <a href="https://blog.tohojo.dk/2017/04/the-story-of-flent-the-flexible-network-tester.html">blog
-    post</a> describing some of the design goals of Flent.</p>
-
+<p>Flent is written in Python and wraps well-known network benchmarking tools (such as
+  <a href="http://netperf.org">netperf</a>
+  and
+  <a href="https://sourceforge.net/p/iperf2">iperf</a>) into aggregate, repeatable tests, such as a number of
+  <a href="https://www.bufferbloat.net/projects/bloat/wiki/Tests_for_Bufferbloat/">tests for Bufferbloat</a>.</p>
+<p>There's a
+  <a href="flent-the-flexible-network-tester.pdf">short paper (pdf)</a>
+  and a
+  <a href="https://blog.tohojo.dk/2017/04/the-story-of-flent-the-flexible-network-tester.html">blog post</a>
+  describing some of the design goals of Flent.</p>
 <h2>Getting started</h2>
-<p>Install Flent as per the instructions below, then see <a
-href="intro.html#quick-start">the Quick-start section</a> to get going.</p>
-<p>For more information, see <a href="contents.html">the full documentation</a>
-or <a href="search.html">search</a> for specific content.</p>
+<p>Install Flent as per the instructions below, then see
+  <a href="intro.html#quick-start">the Quick-start section</a>
+  to get going.</p>
+<p>For more information, see
+  <a href="contents.html">the full documentation</a>
+  or
+  <a href="search.html">search</a>
+  for specific content.</p>
 <h2>Installing Flent</h2>
 <p>Installing Flent can be done in several ways, depending on your operating system:</p>
 <ul>
-  <li><strong>Arch Linux:</strong> Install Flent from <a href="https://aur.archlinux.org/packages/flent">the AUR</a>.</li>
-  <li><strong>Debian and Ubuntu:</strong> <code class="docutils
-  literal"><span class="pre">apt install flent</span></code>. To install
-  netperf, <a href="https://wiki.debian.org/SourcesList">enable the non-free repository</a>.</li>
-  <li><strong>Fedora:</strong> <code class="docutils literal"><span class="pre">dnf install flent</span></code>.</li>
-  <li><strong>Gentoo:</strong> <code class="docutils literal"><span class="pre">emerge net-analyzer/flent</span></code>.</li>
-  <li><strong>Nix:</strong> Flent is available in nixpkgs through the <code class="docutils literal"><span class="pre">flent</span></code> attribute.</li>
-  <li><strong>Ubuntu pre-18.04:</strong> Add the <a
-  href="https://launchpad.net/~tohojo/+archive/ubuntu/flent">tohojo/flent PPA</a>.</li>
-  <li><strong>Other Linux</strong> Install from the <a href="https://pypi.python.org/pypi/flent">Python
-  Package Index</a>: <code class="docutils literal"><span class="pre">pip install flent</span></code></li>
-  <li><strong>FreeBSD:</strong> <code class="docutils literal"><span class="pre">pkg install flent</span></code> to install the package or <code class="docutils literal"><span class="pre">cd /usr/ports/net/flent</span></code> to install the port.</li>
-  <li><strong>OSX with Macbrew:</strong> See install instructions in the <a href="intro.html#installing-flent">Installing flent</a> section</li>
+  <li><strong>Arch Linux:</strong>
+    Install Flent from
+    <a href="https://aur.archlinux.org/packages/flent">the AUR</a>.</li>
+  <li><strong>Debian and Ubuntu:</strong>
+    <code class="docutils literal"><span class="pre">apt install flent</span></code>. To install netperf,
+    <a href="https://wiki.debian.org/SourcesList">enable the non-free repository</a>.</li>
+  <li><strong>Fedora:</strong>
+    <code class="docutils literal"><span class="pre">dnf install flent</span></code>.</li>
+  <li><strong>Gentoo:</strong>
+    <code class="docutils literal"><span class="pre">emerge net-analyzer/flent</span></code>.</li>
+  <li><strong>Nix:</strong>
+    Flent is available in nixpkgs through the
+    <code class="docutils literal"><span class="pre">flent</span></code>
+    attribute.</li>
+  <li><strong>Ubuntu pre-18.04:</strong>
+    Add the
+    <a href="https://launchpad.net/~tohojo/+archive/ubuntu/flent">tohojo/flent PPA</a>.</li>
+  <li><strong>Other Linux</strong>
+    Install from the
+    <a href="https://pypi.python.org/pypi/flent">Python Package Index</a>:
+    <code class="docutils literal"><span class="pre">pip install flent</span></code></li>
+  <li><strong>FreeBSD:</strong>
+    <code class="docutils literal"><span class="pre">pkg install flent</span></code>
+    to install the package or
+    <code class="docutils literal"><span class="pre">cd /usr/ports/net/flent</span></code>
+    to install the port.</li>
+  <li><strong>OSX with Macbrew:</strong>
+    See install instructions in the
+    <a href="intro.html#installing-flent">Installing flent</a>
+    section</li>
 </ul>
 <h2>Get involved</h2>
 <p>Getting involved is easy:</p>
 <ul>
-  <li>Browse the source code or issue tracker <a
-  href="https://github.com/tohojo/flent">on GitHub</a></li>
-  <li>Subscribe to the <a href="https://lists.flent.org/postorius/lists/">mailing lists</a></li>
+  <li>Browse the source code or issue tracker
+    <a href="https://github.com/tohojo/flent">on GitHub</a></li>
+  <li>Subscribe to the
+    <a href="https://lists.flent.org/postorius/lists/">mailing lists</a></li>
 </ul>
 {% endblock %}