tweak warning rendering (#526)

Author: samuelcolvin

docs/.hooks/main.py

@@ -1,9 +1,11 @@
 from __future__ import annotations as _annotations
 
 import re
+import time
 import urllib.parse
 from pathlib import Path
 
+from jinja2 import Environment
 from mkdocs.config import Config
 from mkdocs.structure.files import Files
 from mkdocs.structure.pages import Page
@@ -17,6 +19,11 @@ def on_page_markdown(markdown: str, page: Page, config: Config, files: Files) ->
     return markdown
 
 
+def on_env(env: Environment, config: Config, files: Files) -> Environment:
+    env.globals['build_timestamp'] = str(int(time.time()))
+    return env
+
+
 def replace_uv_python_run(markdown: str) -> str:
     return re.sub(r'```bash\n(.*?)(python/uv[\- ]run|pip/uv[\- ]add|py-cli)(.+?)\n```', sub_run, markdown)
 

docs/.overrides/main.html

@@ -1,8 +1,8 @@
 {% extends "base.html" %}
 {% block content %}
-  <div id="version-warning" style="min-height: 120px"></div>
+  <div id="version-warning"></div>
   <script>
-    fetch('/version-warning.html').then(r => {
+    fetch('/version-warning.html?v={{ build_timestamp }}').then(r => {
       if (r.ok) {
         r.text().then(text => { document.getElementById('version-warning').innerHTML = text })
     } else {

docs/_worker.js

@@ -7,7 +7,11 @@ export default {
     if (url.pathname === '/version-warning.html') {
       try {
         const html = await versionWarning(request, env)
-        return new Response(html, { headers: {'Content-Type': 'text/html', 'Cache-Control': 'max-age=1800'} })
+        const headers = {
+          'Content-Type': 'text/plain',
+          'Cache-Control': 'max-age=2592000', // 30 days
+        }
+        return new Response(html, { headers })
       } catch (e) {
         console.error(e)
         return new Response(
@@ -24,10 +28,10 @@ export default {
 // env looks like
 // {"CF_PAGES":"1","CF_PAGES_BRANCH":"ahead-warning","CF_PAGES_COMMIT_SHA":"...","CF_PAGES_URL":"https://..."}
 async function versionWarning(request, env) {
-  const headers = new Headers({
+  const headers = {
     'User-Agent': request.headers.get('User-Agent') || 'pydantic-ai-docs',
     'Accept': 'application/vnd.github.v3+json',
-  })
+  }
   const r1 = await fetch('https://api.github.com/repos/pydantic/pydantic-ai/releases/latest', {headers})
   if (!r1.ok) {
     const text = await r1.text()
@@ -55,7 +59,7 @@ async function versionWarning(request, env) {
   <p class="admonition-title">Version Notice</p>
   <p>
     ${env.CF_PAGES_BRANCH === 'main' ? '' : `(<b>${env.CF_PAGES_BRANCH}</b> preview)`}
-    This documentation is ahead of the latest release by <b>${ahead_by}</b> commit${ahead_by === 1 ? '' : 's'}.
+    This documentation is ahead of the last release by <b>${ahead_by}</b> commit${ahead_by === 1 ? '' : 's'}.
     You may see documentation for features not yet supported in the latest release <a href="${html_url}">${name}</a>.
   </p>
 </div>`

docs/extra/tweaks.css

@@ -50,3 +50,8 @@ img.index-header {
   font-weight: 300;
   font-style: italic;
 }
+
+#version-warning {
+  min-height: 120px;
+  margin-bottom: 10px;
+}