From d350a468828cf6531d219f1c7548ba0fc9283363 Mon Sep 17 00:00:00 2001
From: Avi Miller <me@dje.li>
Date: Sun, 18 Aug 2024 10:49:04 +1000
Subject: [PATCH] docs: enhance docs by adding version and update date info
 (#2)

---
 mkdocs.yml     | 12 +++++++++
 poetry.lock    | 73 +++++++++++++++++++++++++++++++++++++++++++++++++-
 pyproject.toml |  1 +
 3 files changed, 85 insertions(+), 1 deletion(-)

diff --git a/mkdocs.yml b/mkdocs.yml
index 8474c1e..ffdcc24 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,6 +1,13 @@
 site_name: pyExoyOne
 theme:
   name: material
+  icon:
+    repo: fontawesome/brands/github
+    edit: material/pencil
+    view: material/eye
+  features:
+    - content.action.edit
+    - content.action.view
 
 markdown_extensions:
   - mkdocs-typer
@@ -8,3 +15,8 @@ markdown_extensions:
 plugins:
   - search
   - mkdocstrings
+  - git-revision-date-localized
+
+repo_name: Djelibeybi/pyExoyOne
+repo_url: /~https://github.com/djelibeybi/pyExoyOne
+edit_uri: edit/main/docs/
diff --git a/poetry.lock b/poetry.lock
index 36db3d6..30075fa 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -372,6 +372,38 @@ python-dateutil = ">=2.8.1"
 [package.extras]
 dev = ["flake8", "markdown", "twine", "wheel"]
 
+[[package]]
+name = "gitdb"
+version = "4.0.11"
+description = "Git Object Database"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "gitdb-4.0.11-py3-none-any.whl", hash = "sha256:81a3407ddd2ee8df444cbacea00e2d038e40150acfa3001696fe0dcf1d3adfa4"},
+    {file = "gitdb-4.0.11.tar.gz", hash = "sha256:bf5421126136d6d0af55bc1e7c1af1c397a34f5b7bd79e776cd3e89785c2b04b"},
+]
+
+[package.dependencies]
+smmap = ">=3.0.1,<6"
+
+[[package]]
+name = "gitpython"
+version = "3.1.43"
+description = "GitPython is a Python library used to interact with Git repositories"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "GitPython-3.1.43-py3-none-any.whl", hash = "sha256:eec7ec56b92aad751f9912a73404bc02ba212a23adb2c7098ee668417051a1ff"},
+    {file = "GitPython-3.1.43.tar.gz", hash = "sha256:35f314a9f878467f5453cc1fee295c3e18e52f1b99f10f6cf5b1682e968a9e7c"},
+]
+
+[package.dependencies]
+gitdb = ">=4.0.1,<5"
+
+[package.extras]
+doc = ["sphinx (==4.3.2)", "sphinx-autodoc-typehints", "sphinx-rtd-theme", "sphinxcontrib-applehelp (>=1.0.2,<=1.0.4)", "sphinxcontrib-devhelp (==1.0.2)", "sphinxcontrib-htmlhelp (>=2.0.0,<=2.0.1)", "sphinxcontrib-qthelp (==1.0.3)", "sphinxcontrib-serializinghtml (==1.1.5)"]
+test = ["coverage[toml]", "ddt (>=1.1.1,!=1.4.3)", "mock", "mypy", "pre-commit", "pytest (>=7.3.1)", "pytest-cov", "pytest-instafail", "pytest-mock", "pytest-sugar", "typing-extensions"]
+
 [[package]]
 name = "griffe"
 version = "1.1.0"
@@ -657,6 +689,23 @@ mergedeep = ">=1.3.4"
 platformdirs = ">=2.2.0"
 pyyaml = ">=5.1"
 
+[[package]]
+name = "mkdocs-git-revision-date-localized-plugin"
+version = "1.2.6"
+description = "Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "mkdocs_git_revision_date_localized_plugin-1.2.6-py3-none-any.whl", hash = "sha256:f015cb0f3894a39b33447b18e270ae391c4e25275cac5a626e80b243784e2692"},
+    {file = "mkdocs_git_revision_date_localized_plugin-1.2.6.tar.gz", hash = "sha256:e432942ce4ee8aa9b9f4493e993dee9d2cc08b3ea2b40a3d6b03ca0f2a4bcaa2"},
+]
+
+[package.dependencies]
+babel = ">=2.7.0"
+GitPython = "*"
+mkdocs = ">=1.0"
+pytz = "*"
+
 [[package]]
 name = "mkdocs-material"
 version = "9.5.31"
@@ -1067,6 +1116,17 @@ files = [
 [package.dependencies]
 six = ">=1.5"
 
+[[package]]
+name = "pytz"
+version = "2024.1"
+description = "World timezone definitions, modern and historical"
+optional = false
+python-versions = "*"
+files = [
+    {file = "pytz-2024.1-py2.py3-none-any.whl", hash = "sha256:328171f4e3623139da4983451950b28e95ac706e13f3f2630a879749e7a8b319"},
+    {file = "pytz-2024.1.tar.gz", hash = "sha256:2a29735ea9c18baf14b448846bde5a48030ed267578472d8955cd0e7443a9812"},
+]
+
 [[package]]
 name = "pyyaml"
 version = "6.0.2"
@@ -1356,6 +1416,17 @@ files = [
     {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"},
 ]
 
+[[package]]
+name = "smmap"
+version = "5.0.1"
+description = "A pure Python implementation of a sliding window memory map manager"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "smmap-5.0.1-py3-none-any.whl", hash = "sha256:e6d8668fa5f93e706934a62d7b4db19c8d9eb8cf2adbb75ef1b675aa332b69da"},
+    {file = "smmap-5.0.1.tar.gz", hash = "sha256:dceeb6c0028fdb6734471eb07c0cd2aae706ccaecab45965ee83f11c8d3b1f62"},
+]
+
 [[package]]
 name = "typer"
 version = "0.12.3"
@@ -1534,4 +1605,4 @@ ifaddr = ">=0.1.7"
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.12"
-content-hash = "0eb5ee783e06c1e5ac3efb6e691fe425a4cbe8df659c41600c30c2bdc23bb5e6"
+content-hash = "f4edd51d967b8b1636b8535879d363a16e30c7c20c4fca4e07bb1526505f4961"
diff --git a/pyproject.toml b/pyproject.toml
index b391c8c..a64ea51 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -54,6 +54,7 @@ mkdocs = "^1.6.0"
 mkdocs-material = "^9.5.31"
 mkdocs-typer = "^0.0.3"
 mkdocstrings = {extras = ["python"], version = "^0.25.2"}
+mkdocs-git-revision-date-localized-plugin = "^1.2.6"
 
 [tool.semantic_release]
 version_toml = ["pyproject.toml:tool.poetry.version"]