From 3d3d50d5f9e9cf6386990c85143e0d782a025687 Mon Sep 17 00:00:00 2001 From: patnr Date: Wed, 30 Oct 2024 18:20:03 +0100 Subject: [PATCH] Deploy docs --- .github/workflows/deploy-docs.yml | 53 ++--- requirements.txt | 375 ++++++++++++++++++++++++++++++ 2 files changed, 388 insertions(+), 40 deletions(-) create mode 100644 requirements.txt diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 6ab3295b..ca1dc307 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,49 +1,22 @@ -# From https://github.com/mitmproxy/pdoc/blob/main/.github/workflows/docs.yml -# with minor adaptations - -name: Deploy docs - -# build the documentation whenever there are new commits on main +# From https://github.com/mhausenblas/mkdocs-deploy-gh-pages +name: Publish mkDocs via GitHub Pages on: push: branches: - - master - # Alternative: only build for tags. - # tags: - # - '*' - -# security: restrict permissions for CI jobs. -permissions: - contents: read + - main jobs: - # Build the documentation and upload the static HTML files as an artifact. build: + name: Deploy MkDocs runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - - run: pip install -e .[build] - - run: pdoc -o docs-generated/ -t docs/templates --math --docformat=numpy docs/bib/bib.py docs/dev_guide.py ./dapper + - name: Checkout main + uses: actions/checkout@v2 - - uses: actions/upload-pages-artifact@v1 - with: - path: docs-generated/ - - # Deploy the artifact to GitHub pages. - # This is a separate job so that only actions/deploy-pages has the necessary permissions. - deploy: - needs: build - runs-on: ubuntu-latest - permissions: - pages: write - id-token: write - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - - id: deployment - uses: actions/deploy-pages@v1 + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CONFIG_FILE: mkdocs.yml + REQUIREMENTS: requirements.txt + # CUSTOM_DOMAIN: optionaldomain.com diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..6721ca22 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,375 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile setup.py -o requirements.txt +anyio==4.6.2.post1 + # via + # httpx + # jupyter-server +appnope==0.1.4 + # via ipykernel +argon2-cffi==23.1.0 + # via jupyter-server +argon2-cffi-bindings==21.2.0 + # via argon2-cffi +arrow==1.3.0 + # via isoduration +asttokens==2.4.1 + # via stack-data +async-lru==2.0.4 + # via jupyterlab +attrs==24.2.0 + # via + # jsonschema + # referencing +babel==2.16.0 + # via jupyterlab-server +beautifulsoup4==4.12.3 + # via nbconvert +bleach==6.2.0 + # via nbconvert +certifi==2024.8.30 + # via + # httpcore + # httpx + # requests +cffi==1.17.1 + # via argon2-cffi-bindings +charset-normalizer==3.4.0 + # via requests +colorama==0.4.6 + # via dapper (setup.py) +comm==0.2.2 + # via + # ipykernel + # ipywidgets +contourpy==1.3.0 + # via matplotlib +cycler==0.12.1 + # via matplotlib +debugpy==1.8.7 + # via ipykernel +decorator==5.1.1 + # via + # ipdb + # ipython +defusedxml==0.7.1 + # via nbconvert +dill==0.3.8 + # via + # dapper (setup.py) + # multiprocess + # pathos +executing==2.1.0 + # via stack-data +fastjsonschema==2.20.0 + # via nbformat +fonttools==4.54.1 + # via matplotlib +fqdn==1.5.1 + # via jsonschema +h11==0.14.0 + # via httpcore +httpcore==1.0.6 + # via httpx +httpx==0.27.2 + # via jupyterlab +idna==3.10 + # via + # anyio + # httpx + # jsonschema + # requests +ipdb==0.13.13 + # via dapper (setup.py) +ipykernel==6.29.5 + # via + # jupyter + # jupyter-console + # jupyterlab +ipython==8.29.0 + # via + # dapper (setup.py) + # ipdb + # ipykernel + # ipywidgets + # jupyter-console +ipywidgets==8.1.5 + # via jupyter +isoduration==20.11.0 + # via jsonschema +jedi==0.19.1 + # via ipython +jinja2==3.1.4 + # via + # jupyter-server + # jupyterlab + # jupyterlab-server + # nbconvert +json5==0.9.25 + # via jupyterlab-server +jsonpointer==3.0.0 + # via jsonschema +jsonschema==4.23.0 + # via + # jupyter-events + # jupyterlab-server + # nbformat +jsonschema-specifications==2024.10.1 + # via jsonschema +jupyter==1.1.1 + # via dapper (setup.py) +jupyter-client==8.6.3 + # via + # ipykernel + # jupyter-console + # jupyter-server + # nbclient +jupyter-console==6.6.3 + # via jupyter +jupyter-core==5.7.2 + # via + # ipykernel + # jupyter-client + # jupyter-console + # jupyter-server + # jupyterlab + # nbclient + # nbconvert + # nbformat +jupyter-events==0.10.0 + # via jupyter-server +jupyter-lsp==2.2.5 + # via jupyterlab +jupyter-server==2.14.2 + # via + # jupyter-lsp + # jupyterlab + # jupyterlab-server + # notebook + # notebook-shim +jupyter-server-terminals==0.5.3 + # via jupyter-server +jupyterlab==4.2.5 + # via + # jupyter + # notebook +jupyterlab-pygments==0.3.0 + # via nbconvert +jupyterlab-server==2.27.3 + # via + # jupyterlab + # notebook +jupyterlab-widgets==3.0.13 + # via ipywidgets +kiwisolver==1.4.7 + # via matplotlib +markupsafe==3.0.2 + # via + # jinja2 + # nbconvert +matplotlib==3.8.4 + # via + # dapper (setup.py) + # mpl-tools + # patlib +matplotlib-inline==0.1.7 + # via + # ipykernel + # ipython +mistune==3.0.2 + # via nbconvert +mpl-tools==0.2.50 + # via dapper (setup.py) +multiprocess==0.70.16 + # via pathos +nbclient==0.10.0 + # via nbconvert +nbconvert==7.16.4 + # via + # jupyter + # jupyter-server +nbformat==5.10.4 + # via + # jupyter-server + # nbclient + # nbconvert +nest-asyncio==1.6.0 + # via ipykernel +notebook==7.2.2 + # via jupyter +notebook-shim==0.2.4 + # via + # jupyterlab + # notebook +numpy==1.26.4 + # via + # dapper (setup.py) + # contourpy + # matplotlib + # patlib + # scipy +overrides==7.7.0 + # via jupyter-server +packaging==24.1 + # via + # ipykernel + # jupyter-server + # jupyterlab + # jupyterlab-server + # matplotlib + # nbconvert +pandocfilters==1.5.1 + # via nbconvert +parso==0.8.4 + # via jedi +pathos==0.3.2 + # via dapper (setup.py) +patlib==0.3.5 + # via dapper (setup.py) +pexpect==4.9.0 + # via ipython +pillow==11.0.0 + # via matplotlib +platformdirs==4.3.6 + # via jupyter-core +pox==0.3.5 + # via pathos +ppft==1.7.6.9 + # via pathos +prometheus-client==0.21.0 + # via jupyter-server +prompt-toolkit==3.0.48 + # via + # ipython + # jupyter-console +psutil==6.1.0 + # via ipykernel +ptyprocess==0.7.0 + # via + # pexpect + # terminado +pure-eval==0.2.3 + # via stack-data +pycparser==2.22 + # via cffi +pygments==2.18.0 + # via + # ipython + # jupyter-console + # nbconvert +pyparsing==3.2.0 + # via matplotlib +python-dateutil==2.9.0.post0 + # via + # arrow + # jupyter-client + # matplotlib +python-json-logger==2.0.7 + # via jupyter-events +pyyaml==6.0.2 + # via + # dapper (setup.py) + # jupyter-events +pyzmq==26.2.0 + # via + # ipykernel + # jupyter-client + # jupyter-console + # jupyter-server +referencing==0.35.1 + # via + # jsonschema + # jsonschema-specifications + # jupyter-events +requests==2.32.3 + # via jupyterlab-server +rfc3339-validator==0.1.4 + # via + # jsonschema + # jupyter-events +rfc3986-validator==0.1.1 + # via + # jsonschema + # jupyter-events +rpds-py==0.20.0 + # via + # jsonschema + # referencing +scipy==1.14.1 + # via + # dapper (setup.py) + # mpl-tools + # patlib +send2trash==1.8.3 + # via jupyter-server +setuptools==75.3.0 + # via jupyterlab +six==1.16.0 + # via + # asttokens + # python-dateutil + # rfc3339-validator +sniffio==1.3.1 + # via + # anyio + # httpx +soupsieve==2.6 + # via beautifulsoup4 +stack-data==0.6.3 + # via ipython +struct-tools==0.2.5 + # via dapper (setup.py) +tabulate==0.8.10 + # via dapper (setup.py) +terminado==0.18.1 + # via + # jupyter-server + # jupyter-server-terminals +threadpoolctl==3.5.0 + # via dapper (setup.py) +tinycss2==1.4.0 + # via nbconvert +tornado==6.4.1 + # via + # dapper (setup.py) + # ipykernel + # jupyter-client + # jupyter-server + # jupyterlab + # notebook + # terminado +tqdm==4.66.6 + # via dapper (setup.py) +traitlets==5.14.3 + # via + # comm + # ipykernel + # ipython + # ipywidgets + # jupyter-client + # jupyter-console + # jupyter-core + # jupyter-events + # jupyter-server + # jupyterlab + # matplotlib-inline + # nbclient + # nbconvert + # nbformat +types-python-dateutil==2.9.0.20241003 + # via arrow +uri-template==1.3.0 + # via jsonschema +urllib3==2.2.3 + # via requests +wcwidth==0.2.13 + # via prompt-toolkit +webcolors==24.8.0 + # via jsonschema +webencodings==0.5.1 + # via + # bleach + # tinycss2 +websocket-client==1.8.0 + # via jupyter-server +widgetsnbextension==4.0.13 + # via ipywidgets