Rationalise docs part 5 #151

This commit is contained in:
Ian Renton
2026-09-23 21:42:22 +01:00
parent 5db79ec85a
commit 981fea57ed
22 changed files with 494 additions and 440 deletions
+37 -72
View File
@@ -4,7 +4,7 @@ import os
import threading
import tornado
from tornado.web import RedirectHandler, StaticFileHandler
from tornado.web import StaticFileHandler
from core.config import (
ALLOW_SPOTTING,
@@ -193,79 +193,44 @@ class WebServer:
)
]
else:
ui_routes = (
[
(r"/", PageTemplateHandler, {"template_name": "spots"}),
(
r"/map",
PageTemplateHandler,
{"template_name": "map"},
),
(
r"/bands",
PageTemplateHandler,
{"template_name": "bands"},
),
(
r"/alerts",
PageTemplateHandler,
{"template_name": "alerts"},
),
(
r"/conditions",
PageTemplateHandler,
{"template_name": "conditions"},
),
(
r"/status",
PageTemplateHandler,
{"template_name": "status"},
),
(
r"/help",
PageTemplateHandler,
{"template_name": "help/index"},
),
]
+ [
(
rf"/help/{page}",
PageTemplateHandler,
{"template_name": f"help/{page}"},
)
for page in ["about", "using", "sources", "faq", "accuracy", "privacy", "thanks"]
]
+ [
(
rf"/help/usage/{page}",
PageTemplateHandler,
{"template_name": f"help/usage/{page}"},
)
for page in [
"running",
"docker",
"systemd",
"nginx",
"multicluster",
"clients",
"embedding",
"modifying",
]
]
+ [
# Old "About" page URL, redirect for the benefit of existing links & bookmarks
(r"/about", RedirectHandler, {"url": "/help"}),
]
)
ui_pages = [
"map",
"bands",
"alerts",
"conditions",
"status",
"help",
"help/about",
"help/usage",
"help/usage/clients",
"help/usage/telnet",
"help/usage/embedding",
"help/usage/running",
"help/usage/docker",
"help/usage/nginx",
"help/usage/systemd",
"help/usage/multicluster",
"help/usage/modifying",
"help/sources",
"help/faq",
"help/accuracy",
"help/privacy",
"help/thanks",
]
# Only allow the Add Spot page if spotting is allowed
if ALLOW_SPOTTING:
ui_routes += [
(
r"/add-spot",
PageTemplateHandler,
{"template_name": "add_spot"},
)
]
ui_pages.append("add-spot")
ui_routes = [
(
rf"/{page}",
PageTemplateHandler,
{"template_name": page},
)
for page in ui_pages
]
# One awkward outlier, the home page - we need to serve a route from "/" but can't call a template "/.html"
# so we add this one separately, the template is called "spots"
ui_routes += [(r"/", PageTemplateHandler, {"template_name": "spots"})]
# API docs, Prometheus metrics, webapp manifest and static assets are always available regardless of API-only
# mode.