Add mike as dependency (#272)

Makefile

@@ -17,7 +17,7 @@ clean_pycache: ## Removes the __pycaches__
 
 .PHONY: serve-docs
 serve-docs: ## Runs the local docs
-	mkdocs serve
+	mike serve
 
 .PHONY: build-docs
 build-docs: ## Runs the local docs

docs/overrides/main.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block outdated %}
+  You're not viewing the latest version.
+  <a href="{{ '../' ~ base_url }}">
+    <strong>Click here to go to latest.</strong>
+  </a>
+{% endblock %}

mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: Esmerald
 site_description: 🚀 Highly scalable, performant, easy to learn, easy to code and for every application. 🚀
-site_url: https://esmerald.dev
+site_url: https://esmerald.dev/esmerald/
 
 theme:
   name: "material"
@@ -231,6 +231,8 @@ markdown_extensions:
   - md_in_html
 
 extra:
+  version:
+    provider: mike
   analytics:
     provider: google
     property: G-CNBVBB90NT

pyproject.toml

@@ -135,6 +135,7 @@ dev = [
 
 doc = [
     "griffe-typingdoc>=0.2.2",
+    "mike>=2.0.0",
     "mkautodoc>=0.2.0,<0.3.0",
     "mkdocs>=1.1.2,<2.0.0",
     "mkdocs-material>=9.4.4,<10.0.0",

scripts/docs

@@ -10,4 +10,4 @@ fi
 
 set -x
 
-${PREFIX}mkdocs serve
+${PREFIX}mike serve

scripts/versions

@@ -0,0 +1,16 @@
+#!/bin/sh -e
+
+VERSION_FILE="esmerald/__init__.py"
+VERSION=`grep __version__ ${VERSION_FILE} | grep -o '[0-9][^"]*'`
+
+echo $VERSION
+
+echo "Installing dependencies"
+pip install -U pip && pip install mkdocs mkautodoc mkdocs-material griffe-typingdoc mdx-include pyyaml mkdocs-markdownextradata-plugin mkdocstrings[python] httpx starlette lilya mike a2wsgi mkdocs-meta-descriptions-plugin
+
+echo "Running version generator for version $VERSION"
+mike deploy --push --update-aliases $VERSION latest
+
+
+echo "Setting default latest to version $VERSION"
+mike set-default --push latest