Add the version to the docs homepage so a document bundle is self identifying without external framing.

Author: carl-adams-planet

docs/custom_theme/home.html

@@ -5,7 +5,11 @@
     <div class="md-grid md-typeset">
       <div class="mdx-hero">
         <div class="mdx-hero__content">
-          <h1>Welcome to the {{ config.site_name }}</h1>
+          <h1>
+              Welcome to the {{ config.site_name }}
+              <br/>
+              <span class="h1_subtitle">Version {{ config.extra.planet_sdk_version }}</span>
+          </h1>
           <p>{{ config.site_description }}</p>
           <a href="./{{ 'get-started/quick-start-guide' | url }}" title="Get Started" class="md-button md-button--primary md-button--teriary">
             Get started
@@ -30,11 +34,11 @@ <h1>Welcome to the {{ config.site_name }}</h1>
       <div class="md-footer-right">
           powered by
           <a href="https://www.mkdocs.org" title="MkDocs">MkDocs</a>
-          and 
+          and
           <a href="https://squidfunk.github.io/mkdocs-material/"
             title="Material for MkDocs">
               Material for MkDocs</a>
-      </div>    
+      </div>
   </div>
 </footer>
 {% endblock %}

docs/hooks/mkdocs_hooks.py

@@ -0,0 +1,9 @@
+from planet import __version__ as _pl_sdk_version
+
+def on_config(config):
+    """
+    This is for injecting the package version into mkdocs
+    config so it can be used in templates.
+    """
+    config["extra"]["planet_sdk_version"] = _pl_sdk_version
+    return config

docs/stylesheets/extra.css

@@ -47,7 +47,7 @@ section.mdx-container::before{
     background-repeat: no-repeat;
     background-position: right 10% bottom 45%;
     background-size: auto;
-  
+
 }
 
 
@@ -75,6 +75,10 @@ section.mdx-container::before{
     margin-right: 2.5vw;
 }
 
+.h1_subtitle {
+    font-size: smaller;
+}
+
 @media screen and (min-width:76.25em){
     section.md-sidebar--primary{display:none}
 }
@@ -87,4 +91,4 @@ section.mdx-container::before{
 
 .highlight .gp, .highlight .go { /* Generic.Prompt, Generic.Output */
     user-select: none;
-  }
+  }

mkdocs.yml

@@ -64,6 +64,9 @@ plugins:
         - planet
         - docs/custom_theme/
 
+hooks:
+  - docs/hooks/mkdocs_hooks.py
+
 nav:
   - "Get Started":
     - get-started/quick-start-guide.md

pyproject.toml

@@ -36,7 +36,7 @@ dynamic = ["version"]
 test = ["pytest==8.3.3", "anyio", "pytest-cov", "respx>=0.22.0"]
 lint = ["flake8", "mypy", "yapf==0.43.0"]
 docs = [
-  "mkdocs==1.3",
+  "mkdocs==1.4.2",
   "mkdocs-click==0.7.0",
   "mkdocs-material==8.2.11",
   "mkdocstrings==0.18.1",