update docs with assets, separate docs deploy action from publish

mirumee · Jul 1, 2024 · 93a65c8 · 93a65c8
1 parent 7530974
commit 93a65c8
Show file tree

Hide file tree

Showing 10 changed files with 147 additions and 37 deletions.
diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml
@@ -0,0 +1,32 @@
+name: Deploy documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  docs-publish:
+    name: publish documentation
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: pyproject.toml
+
+      - name: Install Hatch
+        uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc
+
+      - name: Build documentation
+        run: hatch run docs:deploy
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -30,28 +30,3 @@ jobs:
 
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
-
-  docs-publish:
-    name: publish documentation
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout source code
-        uses: actions/checkout@v4
-
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-
-      - name: Set up Python 3.12
-        uses: actions/setup-python@v5
-        with:
-          python-version-file: pyproject.toml
-
-      - name: Install Hatch
-        uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc
-
-      - name: Build documentation
-        run: hatch run docs:deploy
diff --git a/docs/assets/logo_black.svg b/docs/assets/logo_black.svg
diff --git a/docs/assets/logo_white.svg b/docs/assets/logo_white.svg
diff --git a/docs/assets/logo_white_small.svg b/docs/assets/logo_white_small.svg
diff --git a/docs/assets/mirumee.png b/docs/assets/mirumee.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,15 @@
+<p><svg width="995" height="300" viewBox="0 0 995 300" fill="none"
+    xmlns="http://www.w3.org/2000/svg" class="main-logo">
+    <path fill-rule="evenodd" clip-rule="evenodd" d="M146.35 22.5267C163.732 12.4911 185.148 12.4911 202.53 22.5267L270.79 61.9367C288.172 71.9723 298.88 90.5188 298.88 110.59V189.41C298.88 209.481 288.172 228.028 270.79 238.063L202.53 277.473C185.148 287.509 163.732 287.509 146.35 277.473L78.09 238.063C60.7078 228.028 50 209.481 50 189.41V110.59C50 90.5188 60.7078 71.9723 78.09 61.9367L146.35 22.5267ZM120.421 68.9707H133.926C156.301 68.9707 174.44 87.1096 174.44 109.485V136.552C174.472 158.901 192.598 177.008 214.954 177.008L228.459 177.011V231.03H214.954C192.579 231.03 174.44 212.891 174.44 190.516V177.011L174.468 177.008H120.421V68.9707Z" fill="black"/>
+    <path d="M425.181 81V188.856C425.181 191.938 425.823 194.185 427.107 195.597C428.391 196.881 430.766 197.523 434.233 197.523H447.137V219.672H425.951C416.193 219.672 408.553 217.746 403.032 213.894C397.639 210.042 394.943 202.723 394.943 191.938V81H425.181Z" fill="black"/>
+    <path d="M628.019 162.277C628.019 149.566 622.498 143.21 611.455 143.21C605.934 143.21 601.312 145.136 597.588 148.988C593.864 152.711 592.003 158.168 592.003 165.359V219.672H561.764V119.52H591.232V133.002C594.956 128.123 599.45 124.271 604.714 121.446C609.979 118.621 615.949 117.209 622.626 117.209C633.668 117.209 642.335 120.74 648.627 127.802C655.047 134.735 658.257 145.007 658.257 158.618V219.672H628.019V162.277Z" fill="black"/>
+    <path fill-rule="evenodd" clip-rule="evenodd" d="M721.946 219.094C727.082 217.04 731.705 213.701 735.813 209.079V219.672H764.511V147.832C764.511 138.202 760.659 130.691 752.955 125.298C745.379 119.905 734.144 117.209 719.25 117.209C705.511 117.209 694.34 120.226 685.737 126.261C677.135 132.296 672.769 140.963 672.641 152.262H702.686C702.815 148.282 704.355 145.136 707.309 142.825C710.39 140.513 714.499 139.358 719.635 139.358C725.285 139.358 729.265 140.449 731.576 142.632C733.887 144.686 735.043 147.64 735.043 151.492V155.536L707.694 160.159C693.313 162.598 682.977 166.193 676.685 170.944C670.522 175.567 667.44 182.308 667.44 191.167C667.44 200.926 670.779 208.501 677.456 213.894C684.261 219.287 693.185 221.983 704.227 221.983C711.032 221.983 716.939 221.02 721.946 219.094ZM701.916 198.293C699.476 196.239 698.256 193.478 698.256 190.012C698.256 186.545 699.476 183.977 701.916 182.308C704.355 180.638 708.336 179.29 713.857 178.263L735.043 174.026V181.537C735.043 188.086 732.924 193.029 728.687 196.367C724.45 199.577 719.186 201.182 712.894 201.182C708.143 201.182 704.484 200.219 701.916 198.293Z" fill="black"/>
+    <path fill-rule="evenodd" clip-rule="evenodd" d="M915.989 209.079C911.88 213.701 907.258 217.04 902.122 219.094C897.114 221.02 891.208 221.983 884.403 221.983C873.36 221.983 864.437 219.287 857.631 213.894C850.955 208.501 847.616 200.926 847.616 191.167C847.616 182.308 850.698 175.567 856.861 170.944C863.153 166.193 873.489 162.598 887.87 160.159L915.219 155.536V151.492C915.219 147.64 914.063 144.686 911.752 142.632C909.441 140.449 905.46 139.358 899.811 139.358C894.675 139.358 890.566 140.513 887.484 142.825C884.531 145.136 882.99 148.282 882.862 152.262H852.816C852.945 140.963 857.31 132.296 865.913 126.261C874.516 120.226 885.687 117.209 899.426 117.209C914.32 117.209 925.555 119.905 933.131 125.298C940.835 130.691 944.687 138.202 944.687 147.832V219.672H915.989V209.079ZM878.432 190.012C878.432 193.478 879.652 196.239 882.092 198.293C884.66 200.219 888.319 201.182 893.07 201.182C899.361 201.182 904.626 199.577 908.863 196.367C913.1 193.029 915.219 188.086 915.219 181.537V174.026L894.033 178.263C888.512 179.29 884.531 180.638 882.092 182.308C879.652 183.977 878.432 186.545 878.432 190.012Z" fill="black"/>
+    <path d="M776.36 119.52H805.828V137.817C811.477 124.849 821.107 118.364 834.718 118.364H842.999V145.906H833.369C824.51 145.906 817.833 148.153 813.339 152.647C808.845 157.013 806.598 164.46 806.598 174.989V219.672H776.36V119.52Z" fill="black"/>
+    <path d="M470.013 234.31H453.449V258.192H478.487C488.888 258.192 496.977 255.56 502.755 250.295C508.533 245.031 513.284 237.263 517.007 226.991L555.913 119.52H523.363L502.37 192.708L480.799 119.52H448.249L485.999 221.598L485.806 221.983C484.265 226.991 482.468 230.265 480.413 231.806C478.487 233.475 475.021 234.31 470.013 234.31Z" fill="black"/>
+</svg>
+</p>
+
 # Introduction
 
 Lynara is a tool that allows running Python ASGI applications in an AWS Lambda runtime.
@@ -22,7 +34,7 @@ Install Lynara:
 
 Use Lynara with your ASGI application:
 
-```python title="app.py" linenums="1" 
+```python title="app.py" linenums="1"
 import asyncio
 from lynara import Lynara, APIGatewayProxyEventV2Interface
 from fastapi import FastAPI

diff --git a/docs/overrides/partials/copyright.html b/docs/overrides/partials/copyright.html
@@ -1,16 +1,22 @@
 <div class="md-copyright">
-  {% if config.copyright %}
+    {% if config.copyright %}
     <div class="md-copyright__highlight">
-      {{ config.copyright }}
+        {{ config.copyright }}
     </div>
-  {% endif %}
-  {% if not config.extra.generator == false %}
+    {% endif %}
+    {% if not config.extra.generator == false %}
     Made with
     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
+        Material for MkDocs
     </a>
-  {% endif %}
-  <div class="md-copyright__highlight made-with-love">
-    <a href="https://mirumee.com">Lynara is crafted with love by <img class="footer_mirumee_logo" src="/assets/mirumee.png" alt="Mirumee"></a>
-  </div>
+    {% endif %}
+    <div class="md-copyright__highlight made-with-love">
+
+        Lynara is crafted with <span class="twemoji heart"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+                <path
+                    d="M14 20.408c-.492.308-.903.546-1.192.709-.153.086-.308.17-.463.252h-.002a.75.75 0 0 1-.686 0 16.709 16.709 0 0 1-.465-.252 31.147 31.147 0 0 1-4.803-3.34C3.8 15.572 1 12.331 1 8.513 1 5.052 3.829 2.5 6.736 2.5 9.03 2.5 10.881 3.726 12 5.605 13.12 3.726 14.97 2.5 17.264 2.5 20.17 2.5 23 5.052 23 8.514c0 3.818-2.801 7.06-5.389 9.262A31.146 31.146 0 0 1 14 20.408Z">
+                </path>
+            </svg></span> by <a href="https://mirumee.com"><img class="footer_mirumee_logo"
+                src="{{ base_url}}/assets/mirumee.png" alt="Mirumee"></a>
+    </div>
 </div>
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -42,13 +42,14 @@ header {
   line-height: 24px;
 }
 
-.md-copyright .made-with-love .footer_mirumee_logo {
+.md-copyright .made-with-love a img {
   height: 24px;
   vertical-align: top;
   opacity: 0.7;
+  transition: all 0.3s ease-in-out;
 }
 
-.md-copyright .made-with-love:hover .footer_mirumee_logo {
+.md-copyright .made-with-love a:hover img {
   opacity: 1;
 }
 
@@ -59,3 +60,24 @@ tr.benchmarks-best-result {
 tr.benchmarks-worst-result {
   background-color: var(--md-typeset-del-color);
 }
+
+@keyframes heart {
+  0%,
+  40%,
+  80%,
+  100% {
+    transform: scale(1);
+  }
+  20%,
+  60% {
+    transform: scale(1.15);
+  }
+}
+.heart {
+  animation: heart 1000ms infinite;
+  color: #90030c;
+}
+
+.main-logo path {
+  fill: var(--md-primary-fg-color);
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,6 +7,8 @@ copyright: Copyright &copy; 2024 - Mirumee Software
 theme:
   name: material
   custom_dir: docs/overrides
+  logo: assets/logo_black.svg
+  favicon: assets/logo_white_small.svg
   palette:
     scheme: slate
     primary: custom