Turn rest api page into a template

mdellweg · mdellweg · commit 92f957b9c48c · 2025-03-25T12:12:51.000+01:00
diff --git a/custom/rest_api.html b/custom/rest_api.html
@@ -0,0 +1,27 @@
+{% extends "base.html" %}
+
+{% block styles %}
+{{ super() }}
+<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+<style>
+  article.md-content__inner {margin: 0; padding: 0;}
+  article.md-content__inner::before {height: 0;}
+  div.md-main__inner {margin: 0;}
+  div.md-grid {max-width: none;}
+</style>
+{% endblock %}
+
+{% block site_nav %}
+{% endblock %}
+
+{% block content %}
+<redoc spec-url="../api.json"></redoc>
+{% endblock %}
+
+{% block scripts %}
+{{ super() }}
+<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"></script>
+{% endblock %}
+
+{% block footer %}
+{% endblock %}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,6 +7,7 @@ edit_uri_template: "https://github.com/pulp/pulp-docs/edit/main/pulp_docs/{path}
 docs_dir: "pulp_docs"
 theme:
   name: material
+  custom_dir: "custom"
   logo: assets/pulp_logo_icon.svg
   favicon: assets/favicon.ico
   features:
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,7 +14,6 @@ dependencies = [
     "mkdocs-macros-plugin~=1.3.7",
     "mkdocs-site-urls~=0.2.0",
     "mkdocs-literate-nav~=0.6.1",
-    "bs4",
     "httpx",
     "rich",
 ]
diff --git a/src/pulp_docs/plugin.py b/src/pulp_docs/plugin.py
@@ -1,13 +1,11 @@
 import typing as t
 from pathlib import Path
 import json
-import re
 import tomllib
 import yaml
 
 import httpx
 from git import Repo
-from bs4 import BeautifulSoup as bs
 from mkdocs.config import Config, config_options
 from mkdocs.config.defaults import MkDocsConfig
 from mkdocs.plugins import event_priority, get_plugin_logger, BasePlugin
@@ -18,32 +16,12 @@
 
 log = get_plugin_logger(__name__)
 
-SECTION_PATTERN = re.compile(r"([a-z-_]+)/()|(/docs/dev)index.md")
-
 REST_API_MD = """\
 ---
-restapi_json_file: "../api.json"
+template: "rest_api.html"
 ---
 """
 
-REDOC_HEADER = """
-<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
-<style>
-  body {
-    margin: 0;
-    padding: 0;
-  }
-</style>
-"""
-
-REDOC_TAG_TEMPLATE = """
-<redoc spec-url='%s'></redoc>
-"""
-
-REDOC_SCRIPT = """
-<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
-"""
-
 
 @config_options.SubConfig
 class RepositoryOption(Config):
@@ -383,30 +361,3 @@ def on_pre_page(
         if edit_url := pulp_meta.get("edit_url"):
             page.edit_url = edit_url
         return page
-
-    def on_post_page(
-        self,
-        output: str,
-        page: Page,
-        config: MkDocsConfig,
-    ) -> str | None:
-        # TODO reimplement this as a template
-        if basepath := page.meta.get("restapi_json_file"):
-            redoc_tag = REDOC_TAG_TEMPLATE % basepath
-            bs_page = bs(output, "html.parser")
-
-            # Append <head>scripts
-            bs_page.html.head.append(bs(REDOC_HEADER, "html.parser"))
-
-            # Replace main content-container with <redoc> tag
-            main_container = bs_page.find_all("div", class_="md-main__inner")[0]
-            main_container.replace_with(bs(redoc_tag, "html.parser"))
-
-            # Append <script> tag at the end of body
-            bs_page.html.body.append(bs(REDOC_SCRIPT, "html.parser"))
-
-            # Remove footer (looks weird)
-            footer = bs_page.find_all(class_="md-footer")[0]
-            footer.decompose()
-            output = str(bs_page)
-        return output

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@ dependencies = [`
`14`	`14`	`"mkdocs-macros-plugin~=1.3.7",`
`15`	`15`	`"mkdocs-site-urls~=0.2.0",`
`16`	`16`	`"mkdocs-literate-nav~=0.6.1",`
`17`		`- "bs4",`
`18`	`17`	`"httpx",`
`19`	`18`	`"rich",`
`20`	`19`	`]`