From e0288e1457e152e38c251bd04ac44b66dc181f09 Mon Sep 17 00:00:00 2001 From: Dougal Dobie Date: Fri, 9 Aug 2024 13:25:33 +1000 Subject: [PATCH] Fix docs deployment (#741) * Update github actions * Bump to python 3.9 * Updated dependencies * Updated changelog --- .github/workflows/ci-docs-dev.yml | 8 +- .github/workflows/ci-docs-release.yml | 8 +- CHANGELOG.md | 2 + poetry.lock | 127 ++++++++++++-------------- pyproject.toml | 5 +- 5 files changed, 71 insertions(+), 79 deletions(-) diff --git a/.github/workflows/ci-docs-dev.yml b/.github/workflows/ci-docs-dev.yml index e87bf381..9cbd86a5 100644 --- a/.github/workflows/ci-docs-dev.yml +++ b/.github/workflows/ci-docs-dev.yml @@ -11,13 +11,13 @@ jobs: deploy: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 with: fetch-depth: 0 - - uses: actions/setup-python@v2 + - uses: actions/setup-python@v5 with: - python-version: 3.8 - - uses: Gr1N/setup-poetry@v8 + python-version: 3.9 + - uses: Gr1N/setup-poetry@v9 - name: Install system dependencies run: sudo apt-get update && sudo apt-get install -y build-essential libpq-dev libgraphviz-dev - name: Cache Python dependencies diff --git a/.github/workflows/ci-docs-release.yml b/.github/workflows/ci-docs-release.yml index b25f9418..9e64464f 100644 --- a/.github/workflows/ci-docs-release.yml +++ b/.github/workflows/ci-docs-release.yml @@ -8,13 +8,13 @@ jobs: deploy: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 with: fetch-depth: 0 - - uses: actions/setup-python@v2 + - uses: actions/setup-python@v5 with: - python-version: 3.8 - - uses: Gr1N/setup-poetry@v8 + python-version: 3.9 + - uses: Gr1N/setup-poetry@v9 - name: Set release notes tag run: | export RELEASE_TAG_VERSION=${{ github.event.release.tag_name }} diff --git a/CHANGELOG.md b/CHANGELOG.md index f22f95e2..de91a9b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -81,6 +81,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), #### Fixed +- Fixed mkdocs serving issues [#728](https://github.com/askap-vast/vast-pipeline/pull/728) - Fixed python 3.9 testing failing on github actions [#728](https://github.com/askap-vast/vast-pipeline/pull/728) - Updated github action syntax to correctly call docker compose [#736](https://github.com/askap-vast/vast-pipeline/pull/736) - Fix memory leak in new_sources merge [#730](https://github.com/askap-vast/vast-pipeline/pull/730) @@ -124,6 +125,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), #### List of PRs +- [#728](https://github.com/askap-vast/vast-pipeline/pull/728): fix: Adjust package versions and fix mkdocs serve issues - [#728](https://github.com/askap-vast/vast-pipeline/pull/728): fix: Adjust package versions and fix python 3.9 tests breaking on github actions - [#736](https://github.com/askap-vast/vast-pipeline/pull/736): fix: Updated github action syntax to correctly call docker compose - [#730](https://github.com/askap-vast/vast-pipeline/pull/730): fix: Fix memory leak in new_sources merge diff --git a/poetry.lock b/poetry.lock index 147356db..b1020268 100644 --- a/poetry.lock +++ b/poetry.lock @@ -229,13 +229,13 @@ visualize = ["Twisted (>=16.1.1)", "graphviz (>0.5.1)"] [[package]] name = "babel" -version = "2.15.0" +version = "2.16.0" description = "Internationalization utilities" optional = false python-versions = ">=3.8" files = [ - {file = "Babel-2.15.0-py3-none-any.whl", hash = "sha256:08706bdad8d0a3413266ab61bd6c34d0c28d6e1e7badf40a2cebe67644e2e1fb"}, - {file = "babel-2.15.0.tar.gz", hash = "sha256:8daf0e265d05768bc6c7a314cf1321e9a123afc328cc635c18622a2f30a04413"}, + {file = "babel-2.16.0-py3-none-any.whl", hash = "sha256:368b5b98b37c06b7daf6696391c3240c938b37767d4584413e8438c5c435fa8b"}, + {file = "babel-2.16.0.tar.gz", hash = "sha256:d1f3554ca26605fe173f3de0c65f750f5a42f924499bf134de6423582298e316"}, ] [package.dependencies] @@ -2032,20 +2032,19 @@ files = [ [[package]] name = "markdown" -version = "3.6" -description = "Python implementation of John Gruber's Markdown." +version = "3.3.7" +description = "Python implementation of Markdown." optional = false -python-versions = ">=3.8" +python-versions = ">=3.6" files = [ - {file = "Markdown-3.6-py3-none-any.whl", hash = "sha256:48f276f4d8cfb8ce6527c8f79e2ee29708508bf4d40aa410fbc3b4ee832c850f"}, - {file = "Markdown-3.6.tar.gz", hash = "sha256:ed4f41f6daecbeeb96e576ce414c41d2d876daa9a16cb35fa8ed8c2ddfad0224"}, + {file = "Markdown-3.3.7-py3-none-any.whl", hash = "sha256:f5da449a6e1c989a4cea2631aa8ee67caa5a2ef855d551c88f9e309f4634c621"}, + {file = "Markdown-3.3.7.tar.gz", hash = "sha256:cbb516f16218e643d8e0a95b309f77eb118cb138d39a4f27851e6a63581db874"}, ] [package.dependencies] importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""} [package.extras] -docs = ["mdx-gh-links (>=0.2)", "mkdocs (>=1.5)", "mkdocs-gen-files", "mkdocs-literate-nav", "mkdocs-nature (>=0.6)", "mkdocs-section-index", "mkdocstrings[python]"] testing = ["coverage", "pyyaml"] [[package]] @@ -2338,23 +2337,32 @@ mkdocs = ">=1.0" [[package]] name = "mkdocs-material" -version = "8.5.11" +version = "9.5.31" description = "Documentation that simply works" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "mkdocs_material-8.5.11-py3-none-any.whl", hash = "sha256:c907b4b052240a5778074a30a78f31a1f8ff82d7012356dc26898b97559f082e"}, - {file = "mkdocs_material-8.5.11.tar.gz", hash = "sha256:b0ea0513fd8cab323e8a825d6692ea07fa83e917bb5db042e523afecc7064ab7"}, + {file = "mkdocs_material-9.5.31-py3-none-any.whl", hash = "sha256:1b1f49066fdb3824c1e96d6bacd2d4375de4ac74580b47e79ff44c4d835c5fcb"}, + {file = "mkdocs_material-9.5.31.tar.gz", hash = "sha256:31833ec664772669f5856f4f276bf3fdf0e642a445e64491eda459249c3a1ca8"}, ] [package.dependencies] -jinja2 = ">=3.0.2" -markdown = ">=3.2" -mkdocs = ">=1.4.0" -mkdocs-material-extensions = ">=1.1" -pygments = ">=2.12" -pymdown-extensions = ">=9.4" -requests = ">=2.26" +babel = ">=2.10,<3.0" +colorama = ">=0.4,<1.0" +jinja2 = ">=3.0,<4.0" +markdown = ">=3.2,<4.0" +mkdocs = ">=1.6,<2.0" +mkdocs-material-extensions = ">=1.3,<2.0" +paginate = ">=0.5,<1.0" +pygments = ">=2.16,<3.0" +pymdown-extensions = ">=10.2,<11.0" +regex = ">=2022.4" +requests = ">=2.26,<3.0" + +[package.extras] +git = ["mkdocs-git-committers-plugin-2 (>=1.1,<2.0)", "mkdocs-git-revision-date-localized-plugin (>=1.2.4,<2.0)"] +imaging = ["cairosvg (>=2.6,<3.0)", "pillow (>=10.2,<11.0)"] +recommended = ["mkdocs-minify-plugin (>=0.7,<1.0)", "mkdocs-redirects (>=1.2,<2.0)", "mkdocs-rss-plugin (>=1.6,<2.0)"] [[package]] name = "mkdocs-material-extensions" @@ -2386,24 +2394,27 @@ mkdocs = ">=1.4.1" [[package]] name = "mkdocstrings" -version = "0.18.1" +version = "0.25.2" description = "Automatic documentation from sources, for MkDocs." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "mkdocstrings-0.18.1-py3-none-any.whl", hash = "sha256:4053929356df8cd69ed32eef71d8f676a472ef72980c9ffd4f933ead1debcdad"}, - {file = "mkdocstrings-0.18.1.tar.gz", hash = "sha256:fb7c91ce7e3ab70488d3fa6c073a4f827cdc319042f682ef8ea95459790d64fc"}, + {file = "mkdocstrings-0.25.2-py3-none-any.whl", hash = "sha256:9e2cda5e2e12db8bb98d21e3410f3f27f8faab685a24b03b06ba7daa5b92abfc"}, + {file = "mkdocstrings-0.25.2.tar.gz", hash = "sha256:5cf57ad7f61e8be3111a2458b4e49c2029c9cb35525393b179f9c916ca8042dc"}, ] [package.dependencies] +click = ">=7.0" +importlib-metadata = {version = ">=4.6", markers = "python_version < \"3.10\""} Jinja2 = ">=2.11.1" Markdown = ">=3.3" MarkupSafe = ">=1.1" -mkdocs = ">=1.2" +mkdocs = ">=1.4" mkdocs-autorefs = ">=0.3.1" mkdocstrings-python = {version = ">=0.5.2", optional = true, markers = "extra == \"python\""} -mkdocstrings-python-legacy = ">=0.2" +platformdirs = ">=2.2.0" pymdown-extensions = ">=6.3" +typing-extensions = {version = ">=4.1", markers = "python_version < \"3.10\""} [package.extras] crystal = ["mkdocstrings-crystal (>=0.3.4)"] @@ -2412,33 +2423,18 @@ python-legacy = ["mkdocstrings-python-legacy (>=0.2.1)"] [[package]] name = "mkdocstrings-python" -version = "0.6.6" +version = "1.10.5" description = "A Python handler for mkdocstrings." optional = false -python-versions = ">=3.7" -files = [ - {file = "mkdocstrings-python-0.6.6.tar.gz", hash = "sha256:37281696b9f199624ae420e0625b6659b7fdfbea736618bce7fd978682dea3b1"}, - {file = "mkdocstrings_python-0.6.6-py3-none-any.whl", hash = "sha256:c118438d3cb4b14c492a51d109f4e5b27ab06ba19b099d624430dfd904926152"}, -] - -[package.dependencies] -griffe = ">=0.11.1" -mkdocstrings = ">=0.18" - -[[package]] -name = "mkdocstrings-python-legacy" -version = "0.2.2" -description = "A legacy Python handler for mkdocstrings." -optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "mkdocstrings-python-legacy-0.2.2.tar.gz", hash = "sha256:f0e7ec6a19750581b752acb38f6b32fcd1efe006f14f6703125d2c2c9a5c6f02"}, - {file = "mkdocstrings_python_legacy-0.2.2-py3-none-any.whl", hash = "sha256:379107a3a5b8db9b462efc4493c122efe21e825e3702425dbd404621302a563a"}, + {file = "mkdocstrings_python-1.10.5-py3-none-any.whl", hash = "sha256:92e3c588ef1b41151f55281d075de7558dd8092e422cb07a65b18ee2b0863ebb"}, + {file = "mkdocstrings_python-1.10.5.tar.gz", hash = "sha256:acdc2a98cd9d46c7ece508193a16ca03ccabcb67520352b7449f84b57c162bdf"}, ] [package.dependencies] -mkdocstrings = ">=0.18" -pytkdocs = ">=0.14" +griffe = ">=0.47" +mkdocstrings = ">=0.25" [[package]] name = "more-itertools" @@ -2624,6 +2620,16 @@ files = [ {file = "packaging-24.1.tar.gz", hash = "sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002"}, ] +[[package]] +name = "paginate" +version = "0.5.6" +description = "Divides large result sets into pages for easier browsing" +optional = false +python-versions = "*" +files = [ + {file = "paginate-0.5.6.tar.gz", hash = "sha256:5e6007b6a9398177a7e1648d04fdd9f8c9766a1a945bceac82f1929e8c78af2d"}, +] + [[package]] name = "pandas" version = "1.5.3" @@ -3222,17 +3228,17 @@ tests = ["coverage[toml] (==5.0.4)", "pytest (>=6.0.0,<7.0.0)"] [[package]] name = "pymdown-extensions" -version = "10.9" +version = "10.4" description = "Extension pack for Python Markdown." optional = false python-versions = ">=3.8" files = [ - {file = "pymdown_extensions-10.9-py3-none-any.whl", hash = "sha256:d323f7e90d83c86113ee78f3fe62fc9dee5f56b54d912660703ea1816fed5626"}, - {file = "pymdown_extensions-10.9.tar.gz", hash = "sha256:6ff740bcd99ec4172a938970d42b96128bdc9d4b9bcad72494f29921dc69b753"}, + {file = "pymdown_extensions-10.4-py3-none-any.whl", hash = "sha256:cfc28d6a09d19448bcbf8eee3ce098c7d17ff99f7bd3069db4819af181212037"}, + {file = "pymdown_extensions-10.4.tar.gz", hash = "sha256:bc46f11749ecd4d6b71cf62396104b4a200bad3498cb0f5dad1b8502fe461a35"}, ] [package.dependencies] -markdown = ">=3.6" +markdown = ">=3.2" pyyaml = "*" [package.extras] @@ -3302,23 +3308,6 @@ defusedxml = "*" mysql = ["mysql-connector-python"] postgresql = ["psycopg2"] -[[package]] -name = "pytkdocs" -version = "0.16.1" -description = "Load Python objects documentation." -optional = false -python-versions = ">=3.7" -files = [ - {file = "pytkdocs-0.16.1-py3-none-any.whl", hash = "sha256:a8c3f46ecef0b92864cc598e9101e9c4cf832ebbf228f50c84aa5dd850aac379"}, - {file = "pytkdocs-0.16.1.tar.gz", hash = "sha256:e2ccf6dfe9dbbceb09818673f040f1a7c32ed0bffb2d709b06be6453c4026045"}, -] - -[package.dependencies] -astunparse = {version = ">=1.6", markers = "python_version < \"3.9\""} - -[package.extras] -numpy-style = ["docstring_parser (>=0.7)"] - [[package]] name = "pytz" version = "2024.1" @@ -4406,4 +4395,4 @@ prod = ["gevent", "gunicorn"] [metadata] lock-version = "2.0" python-versions = ">=3.8.0,<3.10" -content-hash = "88567d4fed186d20dd424fc98b2a18f03837d72fff8b03fe78a6d5e7d2eafef5" +content-hash = "ec2fe920deecd82cb5e484d0ab955450906dcf72c81da0e826cd01ac0027f625" diff --git a/pyproject.toml b/pyproject.toml index 6ce8fcb5..fcc81343 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -44,8 +44,8 @@ channels = "^3.0.4" param = "<2.0.0" [tool.poetry.dev-dependencies] -mkdocs-material = "^8.2.4" -mkdocstrings = {extras = ["python"], version = "^0.18.0"} +mkdocs-material = "^9.4" +mkdocstrings = {extras = ["python"], version = "^0.25.0"} mkdocs-minify-plugin = "^0" mkdocs-material-extensions = "^1.0.1" mkdocs-gen-files = "^0" @@ -64,6 +64,7 @@ django-stubs = "^1.9.0" lightgallery = "^0" mkdocs-git-revision-date-localized-plugin = "^0" mike = "^1.1.2" +markdown = "3.3.7" [tool.poetry.extras] prod = ["gevent", "gunicorn"]