diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml new file mode 100644 index 0000000..14dd6da --- /dev/null +++ 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 index 8eb18e8..403862b 100644 --- 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 new file mode 100644 index 0000000..afc5269 --- /dev/null +++ b/docs/assets/logo_black.svg @@ -0,0 +1,10 @@ + + + + + + + + + diff --git a/docs/assets/logo_white.svg b/docs/assets/logo_white.svg new file mode 100644 index 0000000..1891b7c --- /dev/null +++ b/docs/assets/logo_white.svg @@ -0,0 +1,10 @@ + + + + + + + + + diff --git a/docs/assets/logo_white_small.svg b/docs/assets/logo_white_small.svg new file mode 100644 index 0000000..fd8da2c --- /dev/null +++ b/docs/assets/logo_white_small.svg @@ -0,0 +1,41 @@ + + + + + + diff --git a/docs/assets/mirumee.png b/docs/assets/mirumee.png new file mode 100644 index 0000000..d3375f8 Binary files /dev/null and b/docs/assets/mirumee.png differ diff --git a/docs/index.md b/docs/index.md index 3ac05b9..19203e5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,15 @@ +

+

+ # 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 index 59ab83c..2668e4b 100644 --- a/docs/overrides/partials/copyright.html +++ b/docs/overrides/partials/copyright.html @@ -1,16 +1,22 @@
- {% if config.copyright %} + {% if config.copyright %}
- {{ config.copyright }} + {{ config.copyright }}
- {% endif %} - {% if not config.extra.generator == false %} + {% endif %} + {% if not config.extra.generator == false %} Made with - Material for MkDocs + Material for MkDocs - {% endif %} -
- Lynara is crafted with love by -
+ {% endif %} +
+ + Lynara is crafted with + + + by +
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index c3c19d6..b3c2b63 100644 --- 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 index af41955..a9671e4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,8 @@ copyright: Copyright © 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