From a7d229f6a27195751d191e5bbf9269aff3f4ccac Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 11:27:04 +0200 Subject: [PATCH 01/20] split ci and doc actions --- .github/workflows/ci.yml | 42 ---------------------- .github/workflows/documentation.yaml | 54 ++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 42 deletions(-) create mode 100644 .github/workflows/documentation.yaml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2d99d2dae8..24560fda5d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -70,22 +70,6 @@ jobs: name: coverage-data path: ".coverage*" - - name: extract openapi schema - env: - DEPLOYMENT_TYPE: development - JWT_SECRET_KEY: 1234 - DATA_DIR_ROOT: /tmp/fractal-server/ - FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ - FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ - run: poetry run fractalctl openapi - - - name: Upload openapi schema - uses: actions/upload-artifact@v3 - with: - name: openapi-schema - path: "openapi.json" - - coverage: name: Coverage runs-on: ubuntu-20.04 @@ -123,29 +107,3 @@ jobs: MINIMUM_ORANGE: 60 ANNOTATE_MISSING_LINES: true ANNOTATION_TYPE: notice - - - docs: - if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} - name: Deploy docs - runs-on: ubuntu-latest - needs: coverage - - steps: - - name: Checkout - uses: actions/checkout@v3 - with: - fetch-depth: 1 - submodules: "recursive" - - - name: Download openapi schema - uses: actions/download-artifact@v3 - with: - name: openapi-schema - path: "docs/" - - - name: Deploy docs - uses: mhausenblas/mkdocs-deploy-gh-pages@master - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - REQUIREMENTS: docs/doc-requirements.txt diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml new file mode 100644 index 0000000000..0ea2358f2d --- /dev/null +++ b/.github/workflows/documentation.yaml @@ -0,0 +1,54 @@ +name: docs + +on: + push: + branches: ["main"] + pull_request: + branches: ["main"] + +jobs: + + docs: + name: "Documentation" + runs-on: ubuntu-latest + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} + + steps: + - uses: actions/checkout@v3 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + REQUIREMENTS: docs/doc-requirements.txt + + docs-build: + name: "Build documentation" + runs-on: ubuntu-latest + if: ${{ github.event_name != 'push' || github.ref != 'refs/heads/main' }} + + steps: + - uses: actions/checkout@v3 + + - name: Install poetry + run: pipx install poetry==1.5 + + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + cache: 'poetry' + + - name: Install dependencies + run: poetry install --with docs --without dev --no-interaction + + - name: extract openapi schema + env: + DEPLOYMENT_TYPE: development + JWT_SECRET_KEY: 1234 + DATA_DIR_ROOT: /tmp/fractal-server/ + FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ + FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ + run: poetry run fractalctl openapi -f docs/openapi.json + + - name: MKDocs build + run: poetry run mkdocs build --config-file mkdocs.yml --strict From 52a726a628a618026e06070131d594ba26e49e27 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 11:30:16 +0200 Subject: [PATCH 02/20] poetry group from `doc` to `docs` --- poetry.lock | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/poetry.lock b/poetry.lock index 7d66bb9b1c..46b66e5132 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2430,4 +2430,4 @@ slurm = ["cloudpickle", "clusterfutures"] [metadata] lock-version = "2.0" python-versions = "^3.9" -content-hash = "22685dc7798bf0fb2a88a02f6d51a7e431db7e194a016bcd776578aec1b034fa" +content-hash = "fc9d189a45c23849d3d6ad9eb7dfe7af23fa545a16aaaa42d0e89d713616880e" diff --git a/pyproject.toml b/pyproject.toml index f8214f56b8..c94e5f0377 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -59,7 +59,7 @@ pytest-subprocess = "^1.4" pytest-docker = {extras = ["docker-compose-v1"], version = "^1.0"} pytest-pretty = "^1.0.1" -[tool.poetry.group.doc.dependencies] +[tool.poetry.group.docs.dependencies] mkdocs = "^1.4.2" mkdocstrings = {extras = ["python"], version = "^0.20"} mkdocs-material = "^8.5.9" From 5249a644008fc049276cfd63e23e8dcb031d7f69 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 11:36:25 +0200 Subject: [PATCH 03/20] update doc action --- .github/workflows/documentation.yaml | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 0ea2358f2d..cf4b8365a8 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -9,7 +9,7 @@ on: jobs: docs: - name: "Documentation" + name: "Deploy docs" runs-on: ubuntu-latest if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} @@ -22,24 +22,25 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} REQUIREMENTS: docs/doc-requirements.txt + docs-build: - name: "Build documentation" + name: "Build docs" runs-on: ubuntu-latest if: ${{ github.event_name != 'push' || github.ref != 'refs/heads/main' }} steps: - uses: actions/checkout@v3 - - name: Install poetry - run: pipx install poetry==1.5 - - uses: actions/setup-python@v4 with: python-version: '3.10' - cache: 'poetry' + cache: pip + + - name: Install current fractal + run: python -m pip install -e . - name: Install dependencies - run: poetry install --with docs --without dev --no-interaction + run: python -m pip install -r docs/doc-requirements.txt - name: extract openapi schema env: @@ -51,4 +52,4 @@ jobs: run: poetry run fractalctl openapi -f docs/openapi.json - name: MKDocs build - run: poetry run mkdocs build --config-file mkdocs.yml --strict + run: mkdocs build --config-file mkdocs.yml --strict From 5312892d3b80c2a9af2b701d797db3fda70f66f0 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 11:40:58 +0200 Subject: [PATCH 04/20] rm poetry --- .github/workflows/documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index cf4b8365a8..9a15ee512d 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -49,7 +49,7 @@ jobs: DATA_DIR_ROOT: /tmp/fractal-server/ FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ - run: poetry run fractalctl openapi -f docs/openapi.json + run: fractalctl openapi -f docs/openapi.json - name: MKDocs build run: mkdocs build --config-file mkdocs.yml --strict From 96d5477bbb50e19990eff393868c1f04d4ec41a9 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 11:45:36 +0200 Subject: [PATCH 05/20] fetch common in action --- .github/workflows/documentation.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 9a15ee512d..8b4fc8f1c1 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -30,6 +30,9 @@ jobs: steps: - uses: actions/checkout@v3 + with: + fetch-depth: 1 + submodules: "recursive" - uses: actions/setup-python@v4 with: From 0ee7546a987e0d3677ee59e188cf903f336ff8e1 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 11:47:43 +0200 Subject: [PATCH 06/20] rm strict option --- .github/workflows/documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 8b4fc8f1c1..f9e7da3c74 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -55,4 +55,4 @@ jobs: run: fractalctl openapi -f docs/openapi.json - name: MKDocs build - run: mkdocs build --config-file mkdocs.yml --strict + run: mkdocs build --config-file mkdocs.yml From babb2e3b1c66bdbedc9912ebf148def7a6257e23 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 11:51:32 +0200 Subject: [PATCH 07/20] test gh-page deploy --- .github/workflows/documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index f9e7da3c74..b818ad8c09 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -11,7 +11,7 @@ jobs: docs: name: "Deploy docs" runs-on: ubuntu-latest - if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} + # if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} steps: - uses: actions/checkout@v3 From f2d76b3db844891f2c03a47a261d6986aa2dbbae Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 12:01:44 +0200 Subject: [PATCH 08/20] openapi action --- .github/workflows/documentation.yaml | 43 +++++++++++++++++++++------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index b818ad8c09..4cbef7da55 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -8,14 +8,45 @@ on: jobs: + openapi: + name: "OpenAPI" + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 1 + submodules: "recursive" + + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + cache: pip + + - name: Install current fractal-server + run: python -m pip install -e . + + - name: extract openapi schema + env: + DEPLOYMENT_TYPE: development + JWT_SECRET_KEY: 1234 + DATA_DIR_ROOT: /tmp/fractal-server/ + FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ + FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ + run: fractalctl openapi -f docs/openapi.json + docs: name: "Deploy docs" + needs: openapi runs-on: ubuntu-latest # if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} steps: - uses: actions/checkout@v3 + - name: Install current fractal-server + run: python -m pip install -e . + - name: Deploy docs uses: mhausenblas/mkdocs-deploy-gh-pages@master env: @@ -25,6 +56,7 @@ jobs: docs-build: name: "Build docs" + needs: openapi runs-on: ubuntu-latest if: ${{ github.event_name != 'push' || github.ref != 'refs/heads/main' }} @@ -39,20 +71,11 @@ jobs: python-version: '3.10' cache: pip - - name: Install current fractal + - name: Install current fractal-server run: python -m pip install -e . - name: Install dependencies run: python -m pip install -r docs/doc-requirements.txt - - name: extract openapi schema - env: - DEPLOYMENT_TYPE: development - JWT_SECRET_KEY: 1234 - DATA_DIR_ROOT: /tmp/fractal-server/ - FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ - FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ - run: fractalctl openapi -f docs/openapi.json - - name: MKDocs build run: mkdocs build --config-file mkdocs.yml From 09a99c56ba2164f8b2fe4c229ef72bf3b607aae3 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 12:08:49 +0200 Subject: [PATCH 09/20] openapi artifact --- .github/workflows/documentation.yaml | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 4cbef7da55..b6ac31727e 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -33,7 +33,13 @@ jobs: DATA_DIR_ROOT: /tmp/fractal-server/ FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ - run: fractalctl openapi -f docs/openapi.json + run: fractalctl openapi -f openapi.json + + - name: Upload openapi schema + uses: actions/upload-artifact@v3 + with: + name: openapi-schema + path: "docs/openapi.json" docs: name: "Deploy docs" @@ -44,6 +50,12 @@ jobs: steps: - uses: actions/checkout@v3 + - name: Download openapi schema + uses: actions/download-artifact@v3 + with: + name: openapi-schema + path: "docs/" + - name: Install current fractal-server run: python -m pip install -e . @@ -66,6 +78,12 @@ jobs: fetch-depth: 1 submodules: "recursive" + - name: Download openapi schema + uses: actions/download-artifact@v3 + with: + name: openapi-schema + path: "docs/" + - uses: actions/setup-python@v4 with: python-version: '3.10' From 2586e79f18cef2333ae6c561cd46b41d7e098891 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 12:15:34 +0200 Subject: [PATCH 10/20] fix artifact upload --- .github/workflows/documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index b6ac31727e..8fbf7ab8d6 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -33,7 +33,7 @@ jobs: DATA_DIR_ROOT: /tmp/fractal-server/ FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ - run: fractalctl openapi -f openapi.json + run: fractalctl openapi -f docs/openapi.json - name: Upload openapi schema uses: actions/upload-artifact@v3 From 5c45f480edb34932245fcc4de7d8b2d86ad5740d Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 12:22:23 +0200 Subject: [PATCH 11/20] clean up jobs --- .github/workflows/documentation.yaml | 69 ++++++++++------------------ 1 file changed, 25 insertions(+), 44 deletions(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 8fbf7ab8d6..1032608d0f 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -8,39 +8,6 @@ on: jobs: - openapi: - name: "OpenAPI" - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3 - with: - fetch-depth: 1 - submodules: "recursive" - - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - cache: pip - - - name: Install current fractal-server - run: python -m pip install -e . - - - name: extract openapi schema - env: - DEPLOYMENT_TYPE: development - JWT_SECRET_KEY: 1234 - DATA_DIR_ROOT: /tmp/fractal-server/ - FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ - FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ - run: fractalctl openapi -f docs/openapi.json - - - name: Upload openapi schema - uses: actions/upload-artifact@v3 - with: - name: openapi-schema - path: "docs/openapi.json" - docs: name: "Deploy docs" needs: openapi @@ -49,16 +16,27 @@ jobs: steps: - uses: actions/checkout@v3 + with: + fetch-depth: 1 + submodules: "recursive" - - name: Download openapi schema - uses: actions/download-artifact@v3 + - uses: actions/setup-python@v4 with: - name: openapi-schema - path: "docs/" + python-version: '3.10' + cache: pip - name: Install current fractal-server run: python -m pip install -e . + - name: extract openapi schema + env: + DEPLOYMENT_TYPE: development + JWT_SECRET_KEY: 1234 + DATA_DIR_ROOT: /tmp/fractal-server/ + FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ + FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ + run: fractalctl openapi -f docs/openapi.json + - name: Deploy docs uses: mhausenblas/mkdocs-deploy-gh-pages@master env: @@ -67,7 +45,7 @@ jobs: docs-build: - name: "Build docs" + name: "Test docs build" needs: openapi runs-on: ubuntu-latest if: ${{ github.event_name != 'push' || github.ref != 'refs/heads/main' }} @@ -78,12 +56,6 @@ jobs: fetch-depth: 1 submodules: "recursive" - - name: Download openapi schema - uses: actions/download-artifact@v3 - with: - name: openapi-schema - path: "docs/" - - uses: actions/setup-python@v4 with: python-version: '3.10' @@ -92,6 +64,15 @@ jobs: - name: Install current fractal-server run: python -m pip install -e . + - name: extract openapi schema + env: + DEPLOYMENT_TYPE: development + JWT_SECRET_KEY: 1234 + DATA_DIR_ROOT: /tmp/fractal-server/ + FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ + FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ + run: fractalctl openapi -f docs/openapi.json + - name: Install dependencies run: python -m pip install -r docs/doc-requirements.txt From ec2f44dac4de2aeda420b0c7417c4235a5efac64 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 12:23:04 +0200 Subject: [PATCH 12/20] rm old var --- .github/workflows/documentation.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 1032608d0f..c61ebfeb02 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -32,7 +32,6 @@ jobs: env: DEPLOYMENT_TYPE: development JWT_SECRET_KEY: 1234 - DATA_DIR_ROOT: /tmp/fractal-server/ FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ run: fractalctl openapi -f docs/openapi.json @@ -68,7 +67,6 @@ jobs: env: DEPLOYMENT_TYPE: development JWT_SECRET_KEY: 1234 - DATA_DIR_ROOT: /tmp/fractal-server/ FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ run: fractalctl openapi -f docs/openapi.json From c4835cb8f28842fb80f0f16727fdb7cabc796132 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 12:24:17 +0200 Subject: [PATCH 13/20] fix actions yaml --- .github/workflows/documentation.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index c61ebfeb02..dd1a2aff28 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -10,7 +10,6 @@ jobs: docs: name: "Deploy docs" - needs: openapi runs-on: ubuntu-latest # if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} @@ -45,7 +44,6 @@ jobs: docs-build: name: "Test docs build" - needs: openapi runs-on: ubuntu-latest if: ${{ github.event_name != 'push' || github.ref != 'refs/heads/main' }} From fa2b385431f473157ad48f10e3db5c273cfb3558 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Fri, 28 Jul 2023 12:26:47 +0200 Subject: [PATCH 14/20] reintroduce if --- .github/workflows/documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index dd1a2aff28..777f51d058 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -11,7 +11,7 @@ jobs: docs: name: "Deploy docs" runs-on: ubuntu-latest - # if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} steps: - uses: actions/checkout@v3 From b04fc1ccfa11ebd6bed98e7d11b6c322f6ada377 Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Tue, 1 Aug 2023 10:12:38 +0200 Subject: [PATCH 15/20] uniform mkdocs.yml to client/task --- docs/extra.css | 17 +++++++++++++++++ mkdocs.yml | 34 ++++++++++++++++++++++++---------- 2 files changed, 41 insertions(+), 10 deletions(-) create mode 100644 docs/extra.css diff --git a/docs/extra.css b/docs/extra.css new file mode 100644 index 0000000000..8a94704c04 --- /dev/null +++ b/docs/extra.css @@ -0,0 +1,17 @@ +/* Custom style for blockquotes */ +blockquote { + background-color: #e7e3e3d8; /* Light gray background */ + border: 1px solid #000000; /* Black border */ + padding: 10px; + margin: 20px 0; + border-radius: 4px; + font-size: 16px; + line-height: 1.6; + box-shadow: 2px 2px 5px rgba(0, 0, 0, 0.1); /* Optional: Add a subtle shadow */ +} + +/* Style the text inside blockquotes */ +blockquote p { + margin: 0; + color: #333; /* Dark text color */ +} diff --git a/mkdocs.yml b/mkdocs.yml index 7ac949e19d..73eb3fa80e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,14 +1,10 @@ -site_name: Fractal Analytics Platform +site_name: Fractal Server repo_url: https://github.com/fractal-analytics-platform/fractal-server -repo_name: fractal-server@github - -extra_css: - - css/mkdocstrings.css +repo_name: fractal-server markdown_extensions: - admonition - #- callouts - pymdownx.details - pymdownx.emoji - pymdownx.magiclink @@ -25,22 +21,25 @@ theme: name: "material" custom_dir: "docs/overrides" features: - - content.code.annotate + - content.code.annotate + - content.code.copy palette: - media: "(prefers-color-scheme: light)" scheme: default primary: teal - accent: purple + accent: green toggle: icon: material/weather-sunny name: Switch to dark mode - media: "(prefers-color-scheme: dark)" scheme: slate - primary: black - accent: lime + primary: teal + accent: green toggle: icon: material/weather-night name: Switch to light mode + icon: + repo: fontawesome/brands/github nav: - Home page: index.md @@ -66,10 +65,25 @@ plugins: nav_file: SUMMARY.md - section-index - mkdocstrings: + default_handler: python handlers: python: options: show_signature_annotations: false docstring_section_style: "table" + docstring_style: "google" + show_source: true filters: [] + show_root_full_path: false - render_swagger + +extra_css: + - extra.css + +copyright: | + © Copyright 2022 + Friedrich Miescher Institute for Biomedical Research and + University of Zurich + (see + LICENSE + ). From a276bc83d689793a85654aa78f67a2590a50c15c Mon Sep 17 00:00:00 2001 From: Yuri Chiucconi Date: Wed, 2 Aug 2023 09:24:48 +0200 Subject: [PATCH 16/20] change color of notes --- docs/extra.css | 2 +- docs/install_and_deploy.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/extra.css b/docs/extra.css index 8a94704c04..8597adb6fa 100644 --- a/docs/extra.css +++ b/docs/extra.css @@ -1,6 +1,6 @@ /* Custom style for blockquotes */ blockquote { - background-color: #e7e3e3d8; /* Light gray background */ + background-color: #ffffff; /* Light gray background */ border: 1px solid #000000; /* Black border */ padding: 10px; margin: 20px 0; diff --git a/docs/install_and_deploy.md b/docs/install_and_deploy.md index 7ccdb7bc1e..05172ce23f 100644 --- a/docs/install_and_deploy.md +++ b/docs/install_and_deploy.md @@ -133,8 +133,10 @@ gunicorn fractal_server.main:app --workers 2 --worker-class uvicorn.workers.Uvic ### Postgres setup -TBD (see preliminary notes at https://github.com/fractal-analytics-platform/fractal-server/issues/388#issuecomment-1366713291) +> See preliminary notes at
+> https://github.com/fractal-analytics-platform/fractal-server/issues/388#issuecomment-1366713291. ### Fractal Server as a daemon/service -TBD (see preliminary notes at https://github.com/fractal-analytics-platform/fractal-server/issues/388#issuecomment-1366719115). +> See preliminary notes at
+> https://github.com/fractal-analytics-platform/fractal-server/issues/388#issuecomment-1366719115. From 31eec60224e6beb265ef0b7ce15bd792669ea32e Mon Sep 17 00:00:00 2001 From: Tommaso Comparin <3862206+tcompa@users.noreply.github.com> Date: Mon, 21 Aug 2023 08:48:58 +0200 Subject: [PATCH 17/20] Remove mkdocs-coverage dependency --- docs/doc-requirements.txt | 1 - poetry.lock | 16 +--------------- pyproject.toml | 1 - 3 files changed, 1 insertion(+), 17 deletions(-) diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt index e11987ee93..04859314cd 100644 --- a/docs/doc-requirements.txt +++ b/docs/doc-requirements.txt @@ -4,5 +4,4 @@ mkdocs-material mkdocs-gen-files mkdocs-literate-nav mkdocs-section-index -mkdocs-coverage mkdocs-render-swagger-plugin diff --git a/poetry.lock b/poetry.lock index 01dbacdcad..7cb17b403d 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1284,20 +1284,6 @@ files = [ Markdown = ">=3.3" mkdocs = ">=1.1" -[[package]] -name = "mkdocs-coverage" -version = "0.2.7" -description = "MkDocs plugin to integrate your coverage HTML report into your site." -optional = false -python-versions = ">=3.7" -files = [ - {file = "mkdocs_coverage-0.2.7-py3-none-any.whl", hash = "sha256:cfb11ab6c7d6c1e30495d0cbb78893937b0715387ea4862d269980300667b0e3"}, - {file = "mkdocs_coverage-0.2.7.tar.gz", hash = "sha256:3616b2508f0197158e684cdb1a08e558c14d435ea3b79e34f71b2f024f6e022b"}, -] - -[package.dependencies] -mkdocs = ">=1.2" - [[package]] name = "mkdocs-gen-files" version = "0.4.0" @@ -2428,4 +2414,4 @@ slurm = ["cloudpickle", "clusterfutures"] [metadata] lock-version = "2.0" python-versions = "^3.9" -content-hash = "33dd4e02746ea89b94ef8d9b441b64d2af32483ff282996b8f4572c5a6d71c84" +content-hash = "e5c5c1b3fb6493983c4fdb4087a29f574d43673f35b8fdb4f4e646476ea0056c" diff --git a/pyproject.toml b/pyproject.toml index bbb0ac4491..4b77b60aec 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -67,7 +67,6 @@ mkdocs-material = "^8.5.9" mkdocs-gen-files = "^0.4.0" mkdocs-literate-nav = "^0.5.0" mkdocs-section-index = "^0.3.4" -mkdocs-coverage = "^0.2.6" mkdocs-render-swagger-plugin = "^0.0.4" pyyaml="5.3.1" From 4f411b37c8ccf6a5fc4a9205a8291b042dc70dbe Mon Sep 17 00:00:00 2001 From: Tommaso Comparin <3862206+tcompa@users.noreply.github.com> Date: Mon, 21 Aug 2023 08:54:27 +0200 Subject: [PATCH 18/20] Fix link to license in docs --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 73eb3fa80e..adf79a0953 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -84,6 +84,6 @@ copyright: | © Copyright 2022 Friedrich Miescher Institute for Biomedical Research and University of Zurich - (see + (see LICENSE ). From 794c5455c5cd05abc7562f56abf039aac5617588 Mon Sep 17 00:00:00 2001 From: Tommaso Comparin <3862206+tcompa@users.noreply.github.com> Date: Mon, 21 Aug 2023 08:58:04 +0200 Subject: [PATCH 19/20] Update mkdocs-material version --- poetry.lock | 115 +++++++++++++++++++++++++++++++++++++++++++++---- pyproject.toml | 2 +- 2 files changed, 108 insertions(+), 9 deletions(-) diff --git a/poetry.lock b/poetry.lock index 7cb17b403d..0248371dac 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1314,22 +1314,24 @@ mkdocs = ">=1.0.3,<2.0.0" [[package]] name = "mkdocs-material" -version = "8.5.11" +version = "9.1.21" description = "Documentation that simply works" optional = false python-versions = ">=3.7" 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.1.21-py3-none-any.whl", hash = "sha256:58bb2f11ef240632e176d6f0f7d1cff06be1d11c696a5a1b553b808b4280ed47"}, + {file = "mkdocs_material-9.1.21.tar.gz", hash = "sha256:71940cdfca84ab296b6362889c25395b1621273fb16c93deda257adb7ff44ec8"}, ] [package.dependencies] -jinja2 = ">=3.0.2" +colorama = ">=0.4" +jinja2 = ">=3.0" markdown = ">=3.2" -mkdocs = ">=1.4.0" +mkdocs = ">=1.5.0" mkdocs-material-extensions = ">=1.1" -pygments = ">=2.12" -pymdown-extensions = ">=9.4" +pygments = ">=2.14" +pymdown-extensions = ">=9.9.1" +regex = ">=2022.4.24" requests = ">=2.26" [[package]] @@ -1995,6 +1997,103 @@ files = [ [package.dependencies] pyyaml = "*" +[[package]] +name = "regex" +version = "2023.8.8" +description = "Alternative regular expression module, to replace re." +optional = false +python-versions = ">=3.6" +files = [ + {file = "regex-2023.8.8-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:88900f521c645f784260a8d346e12a1590f79e96403971241e64c3a265c8ecdb"}, + {file = "regex-2023.8.8-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:3611576aff55918af2697410ff0293d6071b7e00f4b09e005d614686ac4cd57c"}, + {file = "regex-2023.8.8-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b8a0ccc8f2698f120e9e5742f4b38dc944c38744d4bdfc427616f3a163dd9de5"}, + {file = "regex-2023.8.8-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c662a4cbdd6280ee56f841f14620787215a171c4e2d1744c9528bed8f5816c96"}, + {file = "regex-2023.8.8-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cf0633e4a1b667bfe0bb10b5e53fe0d5f34a6243ea2530eb342491f1adf4f739"}, + {file = "regex-2023.8.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:551ad543fa19e94943c5b2cebc54c73353ffff08228ee5f3376bd27b3d5b9800"}, + {file = "regex-2023.8.8-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:54de2619f5ea58474f2ac211ceea6b615af2d7e4306220d4f3fe690c91988a61"}, + {file = "regex-2023.8.8-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:5ec4b3f0aebbbe2fc0134ee30a791af522a92ad9f164858805a77442d7d18570"}, + {file = "regex-2023.8.8-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:3ae646c35cb9f820491760ac62c25b6d6b496757fda2d51be429e0e7b67ae0ab"}, + {file = "regex-2023.8.8-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:ca339088839582d01654e6f83a637a4b8194d0960477b9769d2ff2cfa0fa36d2"}, + {file = "regex-2023.8.8-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:d9b6627408021452dcd0d2cdf8da0534e19d93d070bfa8b6b4176f99711e7f90"}, + {file = "regex-2023.8.8-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:bd3366aceedf274f765a3a4bc95d6cd97b130d1dda524d8f25225d14123c01db"}, + {file = "regex-2023.8.8-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:7aed90a72fc3654fba9bc4b7f851571dcc368120432ad68b226bd593f3f6c0b7"}, + {file = "regex-2023.8.8-cp310-cp310-win32.whl", hash = "sha256:80b80b889cb767cc47f31d2b2f3dec2db8126fbcd0cff31b3925b4dc6609dcdb"}, + {file = "regex-2023.8.8-cp310-cp310-win_amd64.whl", hash = "sha256:b82edc98d107cbc7357da7a5a695901b47d6eb0420e587256ba3ad24b80b7d0b"}, + {file = "regex-2023.8.8-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:1e7d84d64c84ad97bf06f3c8cb5e48941f135ace28f450d86af6b6512f1c9a71"}, + {file = "regex-2023.8.8-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:ce0f9fbe7d295f9922c0424a3637b88c6c472b75eafeaff6f910494a1fa719ef"}, + {file = "regex-2023.8.8-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:06c57e14ac723b04458df5956cfb7e2d9caa6e9d353c0b4c7d5d54fcb1325c46"}, + {file = "regex-2023.8.8-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e7a9aaa5a1267125eef22cef3b63484c3241aaec6f48949b366d26c7250e0357"}, + {file = "regex-2023.8.8-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9b7408511fca48a82a119d78a77c2f5eb1b22fe88b0d2450ed0756d194fe7a9a"}, + {file = "regex-2023.8.8-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:14dc6f2d88192a67d708341f3085df6a4f5a0c7b03dec08d763ca2cd86e9f559"}, + {file = "regex-2023.8.8-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:48c640b99213643d141550326f34f0502fedb1798adb3c9eb79650b1ecb2f177"}, + {file = "regex-2023.8.8-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:0085da0f6c6393428bf0d9c08d8b1874d805bb55e17cb1dfa5ddb7cfb11140bf"}, + {file = "regex-2023.8.8-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:964b16dcc10c79a4a2be9f1273fcc2684a9eedb3906439720598029a797b46e6"}, + {file = "regex-2023.8.8-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:7ce606c14bb195b0e5108544b540e2c5faed6843367e4ab3deb5c6aa5e681208"}, + {file = "regex-2023.8.8-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:40f029d73b10fac448c73d6eb33d57b34607f40116e9f6e9f0d32e9229b147d7"}, + {file = "regex-2023.8.8-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3b8e6ea6be6d64104d8e9afc34c151926f8182f84e7ac290a93925c0db004bfd"}, + {file = "regex-2023.8.8-cp311-cp311-win32.whl", hash = "sha256:942f8b1f3b223638b02df7df79140646c03938d488fbfb771824f3d05fc083a8"}, + {file = "regex-2023.8.8-cp311-cp311-win_amd64.whl", hash = "sha256:51d8ea2a3a1a8fe4f67de21b8b93757005213e8ac3917567872f2865185fa7fb"}, + {file = "regex-2023.8.8-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:e951d1a8e9963ea51efd7f150450803e3b95db5939f994ad3d5edac2b6f6e2b4"}, + {file = "regex-2023.8.8-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:704f63b774218207b8ccc6c47fcef5340741e5d839d11d606f70af93ee78e4d4"}, + {file = "regex-2023.8.8-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:22283c769a7b01c8ac355d5be0715bf6929b6267619505e289f792b01304d898"}, + {file = "regex-2023.8.8-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:91129ff1bb0619bc1f4ad19485718cc623a2dc433dff95baadbf89405c7f6b57"}, + {file = "regex-2023.8.8-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:de35342190deb7b866ad6ba5cbcccb2d22c0487ee0cbb251efef0843d705f0d4"}, + {file = "regex-2023.8.8-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b993b6f524d1e274a5062488a43e3f9f8764ee9745ccd8e8193df743dbe5ee61"}, + {file = "regex-2023.8.8-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:3026cbcf11d79095a32d9a13bbc572a458727bd5b1ca332df4a79faecd45281c"}, + {file = "regex-2023.8.8-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:293352710172239bf579c90a9864d0df57340b6fd21272345222fb6371bf82b3"}, + {file = "regex-2023.8.8-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:d909b5a3fff619dc7e48b6b1bedc2f30ec43033ba7af32f936c10839e81b9217"}, + {file = "regex-2023.8.8-cp36-cp36m-musllinux_1_1_ppc64le.whl", hash = "sha256:3d370ff652323c5307d9c8e4c62efd1956fb08051b0e9210212bc51168b4ff56"}, + {file = "regex-2023.8.8-cp36-cp36m-musllinux_1_1_s390x.whl", hash = "sha256:b076da1ed19dc37788f6a934c60adf97bd02c7eea461b73730513921a85d4235"}, + {file = "regex-2023.8.8-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:e9941a4ada58f6218694f382e43fdd256e97615db9da135e77359da257a7168b"}, + {file = "regex-2023.8.8-cp36-cp36m-win32.whl", hash = "sha256:a8c65c17aed7e15a0c824cdc63a6b104dfc530f6fa8cb6ac51c437af52b481c7"}, + {file = "regex-2023.8.8-cp36-cp36m-win_amd64.whl", hash = "sha256:aadf28046e77a72f30dcc1ab185639e8de7f4104b8cb5c6dfa5d8ed860e57236"}, + {file = "regex-2023.8.8-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:423adfa872b4908843ac3e7a30f957f5d5282944b81ca0a3b8a7ccbbfaa06103"}, + {file = "regex-2023.8.8-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4ae594c66f4a7e1ea67232a0846649a7c94c188d6c071ac0210c3e86a5f92109"}, + {file = "regex-2023.8.8-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e51c80c168074faa793685656c38eb7a06cbad7774c8cbc3ea05552d615393d8"}, + {file = "regex-2023.8.8-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:09b7f4c66aa9d1522b06e31a54f15581c37286237208df1345108fcf4e050c18"}, + {file = "regex-2023.8.8-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2e73e5243af12d9cd6a9d6a45a43570dbe2e5b1cdfc862f5ae2b031e44dd95a8"}, + {file = "regex-2023.8.8-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:941460db8fe3bd613db52f05259c9336f5a47ccae7d7def44cc277184030a116"}, + {file = "regex-2023.8.8-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:f0ccf3e01afeb412a1a9993049cb160d0352dba635bbca7762b2dc722aa5742a"}, + {file = "regex-2023.8.8-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:2e9216e0d2cdce7dbc9be48cb3eacb962740a09b011a116fd7af8c832ab116ca"}, + {file = "regex-2023.8.8-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:5cd9cd7170459b9223c5e592ac036e0704bee765706445c353d96f2890e816c8"}, + {file = "regex-2023.8.8-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:4873ef92e03a4309b3ccd8281454801b291b689f6ad45ef8c3658b6fa761d7ac"}, + {file = "regex-2023.8.8-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:239c3c2a339d3b3ddd51c2daef10874410917cd2b998f043c13e2084cb191684"}, + {file = "regex-2023.8.8-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:1005c60ed7037be0d9dea1f9c53cc42f836188227366370867222bda4c3c6bd7"}, + {file = "regex-2023.8.8-cp37-cp37m-win32.whl", hash = "sha256:e6bd1e9b95bc5614a7a9c9c44fde9539cba1c823b43a9f7bc11266446dd568e3"}, + {file = "regex-2023.8.8-cp37-cp37m-win_amd64.whl", hash = "sha256:9a96edd79661e93327cfeac4edec72a4046e14550a1d22aa0dd2e3ca52aec921"}, + {file = "regex-2023.8.8-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:f2181c20ef18747d5f4a7ea513e09ea03bdd50884a11ce46066bb90fe4213675"}, + {file = "regex-2023.8.8-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:a2ad5add903eb7cdde2b7c64aaca405f3957ab34f16594d2b78d53b8b1a6a7d6"}, + {file = "regex-2023.8.8-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9233ac249b354c54146e392e8a451e465dd2d967fc773690811d3a8c240ac601"}, + {file = "regex-2023.8.8-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:920974009fb37b20d32afcdf0227a2e707eb83fe418713f7a8b7de038b870d0b"}, + {file = "regex-2023.8.8-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd2b6c5dfe0929b6c23dde9624483380b170b6e34ed79054ad131b20203a1a63"}, + {file = "regex-2023.8.8-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:96979d753b1dc3b2169003e1854dc67bfc86edf93c01e84757927f810b8c3c93"}, + {file = "regex-2023.8.8-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:2ae54a338191e1356253e7883d9d19f8679b6143703086245fb14d1f20196be9"}, + {file = "regex-2023.8.8-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:2162ae2eb8b079622176a81b65d486ba50b888271302190870b8cc488587d280"}, + {file = "regex-2023.8.8-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:c884d1a59e69e03b93cf0dfee8794c63d7de0ee8f7ffb76e5f75be8131b6400a"}, + {file = "regex-2023.8.8-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:cf9273e96f3ee2ac89ffcb17627a78f78e7516b08f94dc435844ae72576a276e"}, + {file = "regex-2023.8.8-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:83215147121e15d5f3a45d99abeed9cf1fe16869d5c233b08c56cdf75f43a504"}, + {file = "regex-2023.8.8-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:3f7454aa427b8ab9101f3787eb178057c5250478e39b99540cfc2b889c7d0586"}, + {file = "regex-2023.8.8-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:f0640913d2c1044d97e30d7c41728195fc37e54d190c5385eacb52115127b882"}, + {file = "regex-2023.8.8-cp38-cp38-win32.whl", hash = "sha256:0c59122ceccb905a941fb23b087b8eafc5290bf983ebcb14d2301febcbe199c7"}, + {file = "regex-2023.8.8-cp38-cp38-win_amd64.whl", hash = "sha256:c12f6f67495ea05c3d542d119d270007090bad5b843f642d418eb601ec0fa7be"}, + {file = "regex-2023.8.8-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:82cd0a69cd28f6cc3789cc6adeb1027f79526b1ab50b1f6062bbc3a0ccb2dbc3"}, + {file = "regex-2023.8.8-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:bb34d1605f96a245fc39790a117ac1bac8de84ab7691637b26ab2c5efb8f228c"}, + {file = "regex-2023.8.8-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:987b9ac04d0b38ef4f89fbc035e84a7efad9cdd5f1e29024f9289182c8d99e09"}, + {file = "regex-2023.8.8-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9dd6082f4e2aec9b6a0927202c85bc1b09dcab113f97265127c1dc20e2e32495"}, + {file = "regex-2023.8.8-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7eb95fe8222932c10d4436e7a6f7c99991e3fdd9f36c949eff16a69246dee2dc"}, + {file = "regex-2023.8.8-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7098c524ba9f20717a56a8d551d2ed491ea89cbf37e540759ed3b776a4f8d6eb"}, + {file = "regex-2023.8.8-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4b694430b3f00eb02c594ff5a16db30e054c1b9589a043fe9174584c6efa8033"}, + {file = "regex-2023.8.8-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:b2aeab3895d778155054abea5238d0eb9a72e9242bd4b43f42fd911ef9a13470"}, + {file = "regex-2023.8.8-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:988631b9d78b546e284478c2ec15c8a85960e262e247b35ca5eaf7ee22f6050a"}, + {file = "regex-2023.8.8-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:67ecd894e56a0c6108ec5ab1d8fa8418ec0cff45844a855966b875d1039a2e34"}, + {file = "regex-2023.8.8-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:14898830f0a0eb67cae2bbbc787c1a7d6e34ecc06fbd39d3af5fe29a4468e2c9"}, + {file = "regex-2023.8.8-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:f2200e00b62568cfd920127782c61bc1c546062a879cdc741cfcc6976668dfcf"}, + {file = "regex-2023.8.8-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:9691a549c19c22d26a4f3b948071e93517bdf86e41b81d8c6ac8a964bb71e5a6"}, + {file = "regex-2023.8.8-cp39-cp39-win32.whl", hash = "sha256:6ab2ed84bf0137927846b37e882745a827458689eb969028af8032b1b3dac78e"}, + {file = "regex-2023.8.8-cp39-cp39-win_amd64.whl", hash = "sha256:5543c055d8ec7801901e1193a51570643d6a6ab8751b1f7dd9af71af467538bb"}, + {file = "regex-2023.8.8.tar.gz", hash = "sha256:fcbdc5f2b0f1cd0f6a56cdb46fe41d2cce1e644e3b68832f3eeebc5fb0f7712e"}, +] + [[package]] name = "requests" version = "2.31.0" @@ -2414,4 +2513,4 @@ slurm = ["cloudpickle", "clusterfutures"] [metadata] lock-version = "2.0" python-versions = "^3.9" -content-hash = "e5c5c1b3fb6493983c4fdb4087a29f574d43673f35b8fdb4f4e646476ea0056c" +content-hash = "08185d4d7e6292a54ad9355af997ad12866a64cab1afa5909c4a284f442eaba8" diff --git a/pyproject.toml b/pyproject.toml index 4b77b60aec..e9bafa7e3b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -63,7 +63,7 @@ pyyaml="5.3.1" [tool.poetry.group.docs.dependencies] mkdocs = "^1.4.2" mkdocstrings = {extras = ["python"], version = "^0.20"} -mkdocs-material = "^8.5.9" +mkdocs-material = "^9.1.19" mkdocs-gen-files = "^0.4.0" mkdocs-literate-nav = "^0.5.0" mkdocs-section-index = "^0.3.4" From 59472559efee0d61e795601cfe6d5726a421a2e2 Mon Sep 17 00:00:00 2001 From: Tommaso Comparin <3862206+tcompa@users.noreply.github.com> Date: Mon, 21 Aug 2023 08:58:59 +0200 Subject: [PATCH 20/20] Update CHANGELOG [skip ci] --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a857f37f66..fde2469a83 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ * Improve handling of errors raised in `get_slurm_config` (\#800). * Clarify documentation about `SlurmConfig` (\#798). * Move `tests/test_common.py` into `fractal-common` repository (\#808). +* Update documentation configuration and GitHub actions (\#811). # 1.3.4