Merge pull request #70 from ByteInternet/add_date_variables

Author: tdgroot

.github/workflows/deploy.yaml

@@ -14,7 +14,12 @@ jobs:
     runs-on: ubuntu-latest
     container: quay.io/hypernode/deploy:3-php8.1-node18
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      # Declares the repository safe and not under dubious ownership.
+      - name: Add repository to git safe directories
+        run: git config --global --add safe.directory $GITHUB_WORKSPACE
       - uses: actions/cache@v2
         with:
           path: /tmp/composer-cache

docs/_static/css/general.css

@@ -15,6 +15,10 @@ p {
     }
 }
 
+span, p, div {
+    color: #404040;
+}
+
 a {
     text-decoration: none;
 }
@@ -806,6 +810,31 @@ li.wy-breadcrumbs-aside a {
 
 /* header end */
 
+/* article meta */
+.article-meta {
+    display: inline-block;
+    position: relative;
+    top: 30px;
+    font-size: 11px;
+    font-weight: 600;
+    opacity: 0.35;
+
+    &--updated {
+        opacity: 0.5;
+
+        &::after {
+            content: "•";
+            padding-left: 5px;
+        }
+    }
+
+    @media (max-width: $breakpoint-mobile) {
+        font-size: 12px;
+    }
+}
+
+/* article meta end */
+
 /* footer */
 .edit {
     text-align: center;

docs/_static/css/main.css

@@ -222,16 +222,22 @@
         {%- else %}
         <div class="rst-content">
         {%- endif %}
-          <div role="main" class="document main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+          <div role="main" class="document main-content" itemscope="itemscope" itemtype="https://schema.org/Article">
           {%- block document %}
+          {%- if updated_at %}
+            <div class="article-meta article-meta--updated" itemprop="dateModified">Updated {{ updated_at }}</div>
+           {%- endif %}
+           {%- if created_at %}
+            <div class="article-meta" itemprop="dateCreated">Created {{ created_at }}</div>
+           {%- endif %}
            <div itemprop="articleBody">
              {% block body %}{% endblock %}
            </div>
            {%- if self.comments()|trim %}
              <div class="articleComments">
                {%- block comments %}{% endblock %}
              </div>
-           {%- endif%}
+           {%- endif %}
           </div>
           {%- endblock %}
           {% include "footer.html" %}

docs/_static/scss/general.scss

@@ -4,6 +4,7 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 import os
+import sys
 
 # -- Path setup --------------------------------------------------------------
 
@@ -14,12 +15,13 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+sys.path.append(os.path.abspath("../"))
 
 
 # -- Project information -----------------------------------------------------
 
 project = "Docs"
-copyright = "2022, Hypernode"
+copyright = "2023, Hypernode"
 author = "Hypernode"
 
 # The full version, including alpha/beta/rc tags
@@ -41,6 +43,7 @@
     "myst_parser",
     "sphinx_copybutton",
     "notfound.extension",
+    "hypernode.sphinx.extensions.updated_at",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/_templates/layout.html

@@ -0,0 +1,57 @@
+import os.path
+from datetime import datetime
+from pathlib import Path
+
+import git
+from git.exc import GitCommandError
+from sphinx import errors
+from sphinx.application import Sphinx
+
+
+class PageContextHandler:
+    def __init__(self) -> None:
+        self.git = git.Git(os.path.realpath(os.path.dirname(__file__) + "../../"))
+
+    def execute(self, app: Sphinx, pagename: str, templatename, context, doctree):
+        page_path = Path(app.confdir) / (pagename + ".md")
+        if not os.path.exists(page_path):
+            return
+
+        try:
+            log = self.git.log(
+                "--pretty=format:%aI", "--reverse", page_path
+            ).splitlines()
+            if not log:
+                return
+
+            created = log[0]
+            updated = log[-1]
+        except GitCommandError as exc:
+            raise errors.ExtensionError(
+                "Failed to fetch git history for {}. Exception was: {}".format(
+                    page_path, exc
+                )
+            )
+
+        if created:
+            context["created_at"] = datetime.fromisoformat(created).strftime(
+                app.config.created_at_fmt
+            )
+
+        if updated:
+            context["updated_at"] = datetime.fromisoformat(updated).strftime(
+                app.config.updated_at_fmt
+            )
+
+
+def setup(app: Sphinx):
+    page_context_handler = PageContextHandler()
+    app.add_config_value("updated_at_fmt", "%b %d, %Y", "html")
+    app.add_config_value("created_at_fmt", "%b %d, %Y", "html")
+    app.connect("html-page-context", page_context_handler.execute)
+
+    return {
+        "version": "0.1",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }

docs/conf.py

@@ -9,6 +9,7 @@ mdformat-myst==0.1.5
 mdformat-frontmatter==0.4.1
 sphinx-notfound-page==0.8.3
 sphinx-sitemap==2.4.0
+GitPython==3.1.30
 
 # hypernode/ requirements
 beautifulsoup4==4.11.1