From 7f3b15889f3dac5608d3b5574458bace7841c738 Mon Sep 17 00:00:00 2001 From: collerek Date: Mon, 12 Feb 2024 19:25:44 +0100 Subject: [PATCH] Add mike (#1264) * check return types * set site url * change docs publish to tag, for now comment it out --- .github/workflows/deploy-docs.yml | 14 ++++-- mkdocs.yml | 5 ++ poetry.lock | 76 ++++++++++++++++++++++++++++++- pyproject.toml | 1 + 4 files changed, 92 insertions(+), 4 deletions(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 8116f94..9014b9f 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,7 +1,9 @@ name: Build Documentation using MkDocs on: push: - branches: [ master ] + # Pattern matched against refs/tags + tags: + - '**' jobs: build: name: Build and Deploy Documentation @@ -19,6 +21,12 @@ jobs: poetry install --extras "all" env: POETRY_VIRTUALENVS_CREATE: false - - name: Deploy + - name: Set env + run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV + - name: Test run: | - mkdocs gh-deploy --force + echo $RELEASE_VERSION + echo ${{ env.RELEASE_VERSION }} +# - name: Deploy +# run: | +# mike deploy --push --update-aliases ${{ env.RELEASE_VERSION }} latest diff --git a/mkdocs.yml b/mkdocs.yml index 2c1e972..a07353c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,5 @@ site_name: ormar +site_url: 'https://collerek.github.io/ormar/' site_description: A simple async ORM with fastapi in mind and pydantic validation. nav: - Overview: index.md @@ -77,6 +78,10 @@ markdown_extensions: - pymdownx.highlight: linenums: true plugins: +- mike: + alias_type: symlink + canonical_version: latest + version_selector: true - search - gen-files: scripts: diff --git a/poetry.lock b/poetry.lock index 2a9c875..a74efc9 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1222,6 +1222,25 @@ docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker perf = ["ipython"] testing = ["flufl.flake8", "importlib-resources (>=1.3)", "packaging", "pyfakefs", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-mypy (>=0.9.1)", "pytest-perf (>=0.9.2)", "pytest-ruff"] +[[package]] +name = "importlib-resources" +version = "5.12.0" +description = "Read resources from Python packages" +category = "dev" +optional = false +python-versions = ">=3.7" +files = [ + {file = "importlib_resources-5.12.0-py3-none-any.whl", hash = "sha256:7b1deeebbf351c7578e09bf2f63fa2ce8b5ffec296e0d349139d43cca061a81a"}, + {file = "importlib_resources-5.12.0.tar.gz", hash = "sha256:4be82589bf5c1d7999aedf2a45159d10cb3ca4f19b2271f8792bc8e6da7b22f6"}, +] + +[package.dependencies] +zipp = {version = ">=3.1.0", markers = "python_version < \"3.10\""} + +[package.extras] +docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] +testing = ["flake8 (<5)", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-flake8", "pytest-mypy (>=0.9.1)"] + [[package]] name = "iniconfig" version = "2.0.0" @@ -1393,6 +1412,31 @@ files = [ {file = "mergedeep-1.3.4.tar.gz", hash = "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8"}, ] +[[package]] +name = "mike" +version = "2.0.0" +description = "Manage multiple versions of your MkDocs-powered documentation" +category = "dev" +optional = false +python-versions = "*" +files = [ + {file = "mike-2.0.0-py3-none-any.whl", hash = "sha256:87f496a65900f93ba92d72940242b65c86f3f2f82871bc60ebdcffc91fad1d9e"}, + {file = "mike-2.0.0.tar.gz", hash = "sha256:566f1cab1a58cc50b106fb79ea2f1f56e7bfc8b25a051e95e6eaee9fba0922de"}, +] + +[package.dependencies] +importlib-metadata = "*" +importlib-resources = "*" +jinja2 = ">=2.7" +mkdocs = ">=1.0" +pyparsing = ">=3.0" +pyyaml = ">=5.1" +verspec = "*" + +[package.extras] +dev = ["coverage", "flake8 (>=3.0)", "flake8-quotes", "shtab"] +test = ["coverage", "flake8 (>=3.0)", "flake8-quotes", "shtab"] + [[package]] name = "mkdocs" version = "1.5.3" @@ -2095,6 +2139,21 @@ files = [ ed25519 = ["PyNaCl (>=1.4.0)"] rsa = ["cryptography"] +[[package]] +name = "pyparsing" +version = "3.1.1" +description = "pyparsing module - Classes and methods to define and execute parsing grammars" +category = "dev" +optional = false +python-versions = ">=3.6.8" +files = [ + {file = "pyparsing-3.1.1-py3-none-any.whl", hash = "sha256:32c7c0b711493c72ff18a981d24f28aaf9c1fb7ed5e9667c9e84e3db623bdbfb"}, + {file = "pyparsing-3.1.1.tar.gz", hash = "sha256:ede28a1a32462f5a9705e07aea48001a08f7cf81a021585011deba701581a0db"}, +] + +[package.extras] +diagrams = ["jinja2", "railroad-diagrams"] + [[package]] name = "pytest" version = "7.4.4" @@ -2838,6 +2897,21 @@ secure = ["certifi", "cryptography (>=1.9)", "idna (>=2.0.0)", "pyopenssl (>=17. socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"] zstd = ["zstandard (>=0.18.0)"] +[[package]] +name = "verspec" +version = "0.1.0" +description = "Flexible version handling" +category = "dev" +optional = false +python-versions = "*" +files = [ + {file = "verspec-0.1.0-py3-none-any.whl", hash = "sha256:741877d5633cc9464c45a469ae2a31e801e6dbbaa85b9675d481cda100f11c31"}, + {file = "verspec-0.1.0.tar.gz", hash = "sha256:c4504ca697b2056cdb4bfa7121461f5a0e81809255b41c03dda4ba823637c01e"}, +] + +[package.extras] +test = ["coverage", "flake8 (>=3.7)", "mypy", "pretend", "pytest"] + [[package]] name = "virtualenv" version = "20.24.6" @@ -2992,4 +3066,4 @@ sqlite = ["aiosqlite"] [metadata] lock-version = "2.0" python-versions = "^3.7.0" -content-hash = "7a995564f7364ddaf01db365581b7cbee6273604f1106d6f56169c512477d0f2" +content-hash = "e61acb4cb597d78bc6d1e0aa2d9fd2d144ade8e027aba7c5a66c0cf9442b1e61" diff --git a/pyproject.toml b/pyproject.toml index bbfb2ab..64c3a6e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -142,6 +142,7 @@ all = [ httpx = "^0.24.1" asgi-lifespan = "^2.1.0" pytest-codspeed = "^2.2.0" +mike = "^2.0.0" [build-system] requires = ["poetry-core>=1.0.0"]