Generate an index page with links to all of the docs.

SadieCat · SadieCat · commit 9beb15e76d88 · 2023-12-23T16:04:28.000Z
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -28,7 +28,8 @@ jobs:
 
       - name: Install dependencies
         run: |-
-          apk add doxygen git python3 tar
+          apk add doxygen git python3 py3-pip tar
+          pip3 install --break-system-packages jinja2
 
       - name: Build API docs
         run: |-
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -16,7 +16,8 @@ jobs:
 
       - name: Install dependencies
         run: |-
-          apk add doxygen git python3
+          apk add doxygen git python3 py3-pip
+          pip3 install --break-system-packages jinja2
 
       - name: Build API docs
         run: |-
diff --git a/index.html.j2 b/index.html.j2
@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title>InspIRCd API Documentation</title>
+		<meta charset="utf-8">
+		<style type="text/css">
+			body {
+				color: #444444;
+				font-size: 18px;
+				line-height: 1.5;
+				margin: 50px 15%;
+			}
+			h1 {
+				line-height: 1.2;
+			}
+			li {
+				margin-bottom: 10px;
+			}
+		</style>
+	</head>
+	<body>
+		<h1>InspIRCd API Documentation</h1>
+		{%- for version, directories in docs.items() %}
+			<h2>{{ version }}</h2>
+			<ul>
+			{%- for directory in directories %}
+				<li><a href="{{ directory }}">{{ directory }}</a></li>
+			{%- endfor %}
+			</ul>
+		{%- endfor %}
+		<footer>Documentation generated at {{ time }} using the <a href="https://github.com/inspircd/inspircd-api">InspIRCd API Documentation Builder</a>.</footer>
+	</body>
+</html>
diff --git a/mkapi b/mkapi
@@ -18,13 +18,16 @@
 #
 
 
+import datetime
 import os
 import re
 import shutil
 import subprocess
 import sys
 import tempfile
 
+import jinja2
+
 CC_BOLD  = "\x1B[1m"    if sys.stdout.isatty() else ''
 CC_RED   = "\x1B[1;31m" if sys.stdout.isatty() else ''
 CC_RESET = "\x1B[0m"    if sys.stdout.isatty() else ''
@@ -57,6 +60,7 @@ for file in os.listdir(SITE_DIR):
         print(f"Removing {CC_BOLD}{abs_file}{CC_RESET} from a previous run ...")
         shutil.rmtree(abs_file)
 
+docs = {}
 with tempfile.TemporaryDirectory() as git:
     print(f"Cloning {CC_BOLD}{INSPIRCD_REPOSITORY}{CC_RESET} to {git} ...")
     if subprocess.call([GIT, 'clone', INSPIRCD_REPOSITORY, git]):
@@ -96,3 +100,14 @@ with tempfile.TemporaryDirectory() as git:
                 continue
             print(f"Copying API docs from {CC_BOLD}{DOXYGEN_DIR}{CC_RESET} to {CC_BOLD}{site_dir}{CC_RESET} ...")
             shutil.copytree(DOXYGEN_DIR, site_dir)
+            if not reference in docs:
+                docs[reference] = []
+            docs[reference].append(directory)
+
+env = jinja2.Environment(loader=jinja2.FileSystemLoader(os.path.dirname(__file__)))
+template = env.get_template("index.html.j2")
+with open(os.path.join(SITE_DIR, "index.html"), "w") as fh:
+    fh.write(template.render(
+        docs=docs,
+        time=datetime.datetime.now()
+    ))
diff --git a/site/index.html b/site/index.html
