From dbd2c8afea5f12e2b57a28d8c516a1eebdcbe8af Mon Sep 17 00:00:00 2001
From: Thomas Sileo <t@a4.io>
Date: Tue, 5 Jul 2022 21:35:39 +0200
Subject: [PATCH] Tweak docs

---
 docs/install.md                             | 10 ++++++++++
 docs/templates/layout.html                  |  6 +++++-
 docs/user_guide.md                          |  5 +++++
 scripts/{generate_docs.py => build_docs.py} | 13 +++++++++++--
 tasks.py                                    |  2 +-
 5 files changed, 32 insertions(+), 4 deletions(-)
 create mode 100644 docs/user_guide.md
 rename scripts/{generate_docs.py => build_docs.py} (74%)

diff --git a/docs/install.md b/docs/install.md
index 6c23c8e..ed9ee48 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -1,5 +1,15 @@
+# Installing
+
+[TOC]
+
+## Docker edition
+
+TODO
+
 ## Python developer edition
 
+Assuming you have a working **Python 3.10+** environment. 
+
 Setup [Poetry](https://python-poetry.org/docs/master/#installing-with-the-official-installer).
 
 ```bash
diff --git a/docs/templates/layout.html b/docs/templates/layout.html
index 9152101..4def13d 100644
--- a/docs/templates/layout.html
+++ b/docs/templates/layout.html
@@ -30,7 +30,10 @@ nav.flexbox ul li {
 nav.flexbox ul li:last-child {
     margin-right: 0px;
 }
-h1 {
+h1, h2, h3, h4, h5, h6 {
+    font-weight: normal;
+}
+header h1 {
     font-weight: normal;
     text-align: center;
     margin: 30px auto;
@@ -80,6 +83,7 @@ code {
         <ul>
             <li><a href="/"{% if path == "/" %} class="active"{% endif %}>Home</a>
             <li><a href="/installing.html"{% if path == "/installing.html" %} class="active"{% endif %}>Installing</a>
+            <li><a href="/user_guide.html"{% if path == "/user_guide.html" %} class="active"{% endif %}>User guide</a>
             <li><a href="https://sr.ht/~tsileo/microblog.pub/">Source code</a>
             <li><a href="https://todo.sr.ht/~tsileo/microblog.pub">Bug tracker</a>
             <li><a href="https://sr.ht/~tsileo/microblog.pub/lists">Mailing list</a>
diff --git a/docs/user_guide.md b/docs/user_guide.md
new file mode 100644
index 0000000..6569fac
--- /dev/null
+++ b/docs/user_guide.md
@@ -0,0 +1,5 @@
+# User guide
+
+[TOC]
+
+TODO
diff --git a/scripts/generate_docs.py b/scripts/build_docs.py
similarity index 74%
rename from scripts/generate_docs.py
rename to scripts/build_docs.py
index 5c79ff6..1b78515 100644
--- a/scripts/generate_docs.py
+++ b/scripts/build_docs.py
@@ -10,7 +10,9 @@ from app.config import VERSION
 
 
 def markdownify(content: str) -> str:
-    return markdown(content, extensions=["mdx_linkify", "fenced_code", "codehilite"])
+    return markdown(content, extensions=[
+        "mdx_linkify", "fenced_code", "codehilite", "toc"
+    ])
 
 
 def main() -> None:
@@ -33,11 +35,18 @@ def main() -> None:
 
     install = Path("docs/install.md")
     template.stream(
-        content=markdownify(install.read_text().removeprefix("# microblog.pub")),
+        content=markdownify(install.read_text()),
         version=VERSION,
         path="/installing.html",
     ).dump("docs/dist/installing.html")
 
+    user_guide = Path("docs/user_guide.md")
+    template.stream(
+        content=markdownify(user_guide.read_text()),
+        version=VERSION,
+        path="/user_guide.html",
+    ).dump("docs/dist/user_guide.html")
+
 
 if __name__ == "__main__":
     main()
diff --git a/tasks.py b/tasks.py
index f0ab13f..b3704fc 100644
--- a/tasks.py
+++ b/tasks.py
@@ -96,7 +96,7 @@ def build_configuration_wizard_image(ctx):
 @task
 def build_docs(ctx):
     # type: (Context) -> None
-    run("PYTHONPATH=. poetry run python scripts/generate_docs.py", pty=True, echo=True)
+    run("PYTHONPATH=. poetry run python scripts/build_docs.py", pty=True, echo=True)
 
 
 @task