new: [website] New optional blueprint able to serve the static HTML f…

…iles generated by Sphinx for the documentation of Vulnerability-Lookup.

website/app.py

@@ -13,6 +13,7 @@
     from website.web import views
 
     application.register_blueprint(views.home_bp)
+    application.register_blueprint(views.documentation_bp)
     if get_config("generic", "user_accounts"):
         application.config["user_accounts"] = True
         application.register_blueprint(views.admin_bp)

website/web/views/__init__.py

@@ -2,6 +2,7 @@
 from website.web.views.admin import admin_bp
 from website.web.views.bundle import bundle_bp, bundles_bp
 from website.web.views.comment import comment_bp, comments_bp
+from website.web.views.documentation import documentation_bp
 from website.web.views.home import home_bp
 from website.web.views.user import user_bp, users_bp
 from website.web.views.sighting import sighting_bp, sightings_bp
@@ -17,6 +18,7 @@
     "bundle_bp",
     "comment_bp",
     "comments_bp",
+    "documentation_bp",
     "sighting_bp",
     "sightings_bp",
 ]

website/web/views/documentation.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+
+from flask import abort
+from flask import Blueprint
+from flask import send_from_directory
+from werkzeug import Response as WerkzeugResponse
+
+from vulnerabilitylookup.default import get_homedir
+
+# Define the blueprint
+homedir = get_homedir()
+static_folder = homedir.joinpath("docs/_build/html")
+documentation_bp = Blueprint('documentation', __name__, url_prefix="/documentation", static_folder=static_folder)
+
+
+@documentation_bp.route('/<path:filename>')
+def serve_documentation(filename: str) -> WerkzeugResponse:
+    """Serve static files from the Sphinx build folder."""
+    if None is documentation_bp.static_folder:
+        return abort(404)
+    return send_from_directory(documentation_bp.static_folder, filename)
+
+
+@documentation_bp.route('/')
+def serve_index() -> WerkzeugResponse:
+    """Redirect `/documentation` to `/documentation/index.html`"""
+    if None is documentation_bp.static_folder:
+        return abort(404)
+    return send_from_directory(documentation_bp.static_folder, 'index.html')