support theme (using html-page-context)

src/ablog/__init__.py

@@ -67,6 +67,51 @@ def builder_support(builder):
     return builder.format == "html" and builder.name not in not_supported
 
 
+
+def update_blogpage_context(app, context):
+    """Inject ABlog page content into `context["body"]` when needed.
+
+    Why pre-render `body`?
+    -----------------------
+    Sphinx themes differ in where they place page content: some render `{{ body }}`
+    in the `{% block content %}`, others render it in the `{% block body %}`.
+    ABlog's catalog/collection/redirect pages need to work across themes without
+    relying on a specific block structure, so we render the final HTML fragment
+    ourselves and put it into `context["body"]`.
+    """
+    if "redirect" in context:
+        context["metatags"] = context.get("metatags", "")
+        context["metatags"] += app.builder.templates.render_string(
+            """
+    <meta
+      http-equiv="refresh"
+      content="{{ ablog.post_redirect_refresh }}; url={{ pathto(redirect) }}"
+    />""",
+            context,
+        )
+        context["body"] = app.builder.templates.render(
+            "ablog/content/redirect.html",
+            context,
+        )
+        return
+
+    if "collection" in context or "catalog" in context:
+        def postlink(post):
+            if post.external_link:
+                return post.external_link
+            else:
+                return context["pathto"](post.docname) + context["anchor"](post)
+
+        context["postlink"] = postlink
+
+        template = (
+            "ablog/content/collection.html"
+            if "collection" in context
+            else "ablog/content/catalog.html"
+        )
+        context["body"] = app.builder.templates.render(template, context)
+
+
 def html_page_context(app, pagename, templatename, context, doctree):
     if builder_support(app):
         context["ablog"] = blog = Blog(app)
@@ -78,6 +123,17 @@ def html_page_context(app, pagename, templatename, context, doctree):
             context["feed_path"] = blog.blog_path
             context["feed_title"] = blog.blog_title
 
+        if templatename == "ablog/blog.html":
+            update_blogpage_context(app, context)
+            return
+
+        # Replace the default page template (typically `page.html`) with ABlog's
+        # wrapper template for post pages and blog-related pages.
+        # See: https://www.sphinx-doc.org/en/master/extdev/event_callbacks.html#event-html-page-context
+        if pagename in blog or pagename.startswith(blog.config["blog_path"]):
+            if not templatename.startswith("ablog/"):
+                return "ablog/blog.html"
+
 
 def config_inited(app, config):
     # Automatically identify any blog posts if a pattern is specified in the config

src/ablog/post.py

@@ -568,7 +568,8 @@ def generate_archive_pages(app):
         register_posts(app)
     for post in blog.posts:
         for redirect in post.redirect:
-            yield (redirect, {"redirect": post.docname, "post": post}, "ablog/redirect.html")
+            yield (redirect, {"redirect": post.docname, "post": post}, "ablog/blog.html")
+
     found_docs = app.env.found_docs
     atom_feed = bool(blog.blog_baseurl)
     feed_archives = blog.blog_feed_archives
@@ -585,7 +586,7 @@ def generate_archive_pages(app):
             continue
         context = {"parents": [], "title": title, "header": header, "catalog": catalog, "summary": True}
         if catalog.docname not in found_docs:
-            yield (catalog.docname, context, "ablog/catalog.html")
+            yield (catalog.docname, context, "ablog/blog.html")
         for collection in catalog:
             if not collection:
                 continue
@@ -600,7 +601,7 @@ def generate_archive_pages(app):
             }
             context["feed_title"] = context["title"]
             if collection.docname not in found_docs:
-                yield (collection.docname, context, "ablog/collection.html")
+                yield (collection.docname, context, "ablog/blog.html")
     if 1:
         context = {
             "parents": [],
@@ -612,9 +613,9 @@ def generate_archive_pages(app):
             "feed_path": blog.blog_path,
         }
         docname = blog.posts.docname
-        yield (docname, context, "ablog/collection.html")
+        yield (docname, context, "ablog/blog.html")
     context = {"parents": [], "title": _("Drafts"), "collection": blog.drafts, "summary": True}
-    yield (blog.drafts.docname, context, "ablog/collection.html")
+    yield (blog.drafts.docname, context, "ablog/blog.html")
 
 
 def generate_atom_feeds(app):

src/ablog/templates/ablog/blog.html

@@ -0,0 +1,21 @@
+{%- extends "page.html" %}
+{%- block extrahead %}
+  {{ super() }}
+  {%- if feed_path %}
+    <link
+      rel="alternate"
+      type="application/atom+xml"
+      href="{{ pathto(feed_path, 1) }}/atom.xml"
+      title="{{ feed_title }}"
+    />
+  {%- endif %}
+  {%- if ablog.fontawesome_link_cdn %}
+    <link rel="stylesheet" href="{{ ablog.fontawesome_link_cdn }}"/>
+  {%- elif ablog.fontawesome_css_file %}
+    <link
+      rel="stylesheet"
+      href="{{ pathto('_static/' + ablog.fontawesome_css_file, 1) }}"
+      type="text/css"
+    />
+  {%- endif %}
+{%- endblock %}

src/ablog/templates/ablog/catalog.html → src/ablog/templates/ablog/content/catalog.html

@@ -1,7 +1,4 @@
-{%- extends "page.html" %} {% macro postlink(post) -%} {% if post.external_link
--%} {{- post.external_link -}} {% else %} {{- pathto(post.docname) }}{{
-anchor(post) -}} {%- endif %} {%- endmacro %} {% block body %} {% for collection
-in catalog %} {% if collection %}
+{% for collection in catalog %} {% if collection %}
 <div class="section ablog__catalog_header">
   <h2>
     <span
@@ -22,4 +19,4 @@ <h2>
   </div>
   {% endfor %}
 </div>
-{% endif %} {% endfor %} {% endblock body %}
+{% endif %} {% endfor %}

src/ablog/templates/ablog/collection.html → src/ablog/templates/ablog/content/collection.html

@@ -1,6 +1,3 @@
-{%- extends "page.html" %} {% block body %} {% macro postlink(post) -%} {% if
-post.external_link -%} {{- post.external_link -}} {% else %} {{-
-pathto(post.docname) }}{{ anchor(post) -}} {%- endif %} {%- endmacro %}
 <div class="section ablog__collection">
   <h1>
     {% if archive_feed and fa %}
@@ -54,4 +51,3 @@ <h2 class="ablog-post-title">
   </div>
   {% endfor %} {% endif %}
 </div>
-{% endblock body %}

src/ablog/templates/ablog/content/redirect.html

@@ -0,0 +1 @@
+You are being redirected to <a href="{{ pathto(redirect) }}">{{ post.title }}</a> in {{ ablog.post_redirect_refresh }} seconds;

src/ablog/templates/page.html → src/ablog/templates/ablog/disqus.html

@@ -1,23 +1,5 @@
-{%- extends "layout.html" %} {% set fa = ablog.fontawesome %} {%- block
-extrahead %} {{ super() }} {% if feed_path %}
-<link
-  rel="alternate"
-  type="application/atom+xml"
-  href="{{ pathto(feed_path, 1) }}/atom.xml"
-  title="{{ feed_title }}"
-/>
-{% endif %} {% if ablog.fontawesome_link_cdn %}
-<link href="{{ ablog.fontawesome_link_cdn }}" rel="stylesheet" />
-{% elif ablog.fontawesome_css_file %}
-<link
-  rel="stylesheet"
-  href="{{ pathto('_static/' + ablog.fontawesome_css_file, 1) }}"
-  type="text/css"
-/>
-{% endif %} {% endblock extrahead %} {% block body %} {{ body }}
 <div class="section ablog__blog_comments">
-  {% if pagename in ablog %} {% include "ablog/postnavy.html" %} {% endif %} {%
-  if ablog.disqus_shortname and ablog.blog_baseurl and (not
+  {% if ablog.disqus_shortname and ablog.blog_baseurl and (not
   ablog[pagename].nocomments) and ((pagename in ablog and
   (ablog[pagename].published or ablog.disqus_drafts)) or (not pagename in ablog
   and ablog.disqus_pages)) %}
@@ -53,4 +35,3 @@ <h2>Comments</h2>
   </div>
   {% endif %}
 </div>
-{% endblock body %}

src/ablog/templates/ablog/postnavy.html

@@ -1,4 +1,5 @@
-{# prev/next are not set for drafts #} {% set post = ablog[pagename] %} {% if
+{# prev/next are not set for drafts #}
+{% if pagename in ablog %}{% set post = ablog[pagename] %} {% if
 post.published and ablog.post_show_prev_next %}
 <div class="section ablog__prev-next">
   <span class="ablog__prev">
@@ -26,3 +27,4 @@
   </span>
 </div>
 {% endif %}
+{% endif %}