docs: add 'latest' note

eth-sri · Sep 8, 2023 · 5e4caf6 · 5e4caf6
1 parent 991518f
commit 5e4caf6
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 7 deletions.
diff --git a/docs/source/_templates/layout.html → docs/source/_templates/base.html b/docs/source/_templates/layout.html → docs/source/_templates/base.html
@@ -1,6 +1,7 @@
-{% extends "!layout.html" %}
+{% extends "!base.html" %}
 
-{% block footer %}
-{{ super() }}
+{% block scripts %}
+{{super()}}
 <!-- Cloudflare Web Analytics --><script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{"token": "b5047b826dff4e4db4b9193bb47eec37"}'></script><!-- End Cloudflare Web Analytics -->
-{% endblock %}
+{% endblock %}
+
diff --git a/docs/source/_templates/page.html b/docs/source/_templates/page.html
@@ -0,0 +1,9 @@
+{% extends "!page.html" %}
+
+{% block content %}
+<!-- only if config release version is 'latest' -->
+{% if release == 'latest' %}
+<div class="latest-note"> You are reading the <i>latest</i> version of the documentation. Functionality described here, is only available in the latest version of the LMQL. </div>
+{% endif %}
+{{super()}}
+{% endblock %}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -79,5 +79,5 @@
             "title": "Community",
             "url": "https://discord.gg/7eJP4fcyNT"
         }
-    ],
-}
+    ]
+}
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,6 +1,6 @@
 Welcome To LMQL
 ===================================
-
+ 
 .. raw:: html
 
   <div class="subtitle"><img class="inline-logo" src="_static/images/lmql.svg"/> LMQL is a programming language for large language model interaction.</div>
@@ -137,3 +137,4 @@ To learn more about LMQL, select one of the following sections or navigate the d
     Discord <https://discord.gg/7eJP4fcyNT>
     GitHub Issues <https://github.com/eth-sri/lmql/issues>
     E-Mail <mailto:[email protected]>
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -79,5 +79,5 @@ @@
                 "title": "Community",
                 "url": "https://discord.gg/7eJP4fcyNT"
             }
-        ],
-    }
+        ]
+    }