From cfbe03aeff589896ee9c02c99b88131d4516be62 Mon Sep 17 00:00:00 2001 From: Yann1cks <50637827+yann1cks@users.noreply.github.com> Date: Sat, 2 Nov 2024 17:02:09 +0100 Subject: [PATCH 1/4] gh-pages documentation --- .github/workflows/documentation.yml | 54 +++++++++++++++++++++++++++++ CNAME | 1 + 2 files changed, 55 insertions(+) create mode 100644 .github/workflows/documentation.yml create mode 100644 CNAME diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000..da962765 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,54 @@ +name: Deploy Documentation to Github Pages + +on: workflow_dispatch + # Alternative: trigger deployment on push + # push: + # branches: [main] + +# Cancel any in-progress job or run +# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency +concurrency: + group: ${{ github.ref }} + cancel-in-progress: true + +jobs: + pages: + runs-on: ubuntu-24.04 + environment: + name: documentation-github-pages + url: ${{ steps.deployment.outputs.page_url }} + permissions: + pages: write + id-token: write + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup python + uses: actions/setup-python@v5 + with: + python-version: '3.13' + - name: Enable github problem matcher + uses: sphinx-doc/github-problem-matcher@master + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -U pip setuptools wheel + pip install .[docs] + - name: Sphinx build + run: > + sphinx-build + -b html ./docs ./docs/_builds + -v + --jobs=auto + --show-traceback + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Path to build dir, see 'sphinx run' + path: './docs/_builds' + - id: deployment + name: Deploy to GitHub Pages + uses: actions/deploy-pages@v4 + + + diff --git a/CNAME b/CNAME new file mode 100644 index 00000000..fadf193a --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +pingouin.stadtfeld.xyz \ No newline at end of file From 115799df9dfee5c2563345a79cd7a34bed38ee21 Mon Sep 17 00:00:00 2001 From: Yann1cks <50637827+yann1cks@users.noreply.github.com> Date: Sat, 2 Nov 2024 17:26:07 +0100 Subject: [PATCH 2/4] rename deploy job --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index da962765..28341fd7 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -12,7 +12,7 @@ concurrency: cancel-in-progress: true jobs: - pages: + deploy-to-gh-pages: runs-on: ubuntu-24.04 environment: name: documentation-github-pages From b52b879c92315b5fc45f60d6335e40082a81e690 Mon Sep 17 00:00:00 2001 From: Yann1cks <50637827+yann1cks@users.noreply.github.com> Date: Sun, 3 Nov 2024 07:44:33 +0100 Subject: [PATCH 3/4] fix 404 page --- docs/conf.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 7868ed58..09f89679 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -129,6 +129,21 @@ "doc_path": "docs", } +# -- 404 page ------------------------------------------------ + +# Remove default url prefix on 404 pages +# https://sphinx-notfound-page.readthedocs.io/en/latest/configuration.html#confval-notfound_urls_prefix +#notfound_urls_prefix = "/test/", +notfound_no_urls_prefix = True + +notfound_context = { + "title": "Page Not Found (404)", + "body": """ +

Page Not Found

+

Sorry, we couldn't find that page.

+

Try using the search box or go to the homepage.

+ """, +} # -- Intersphinx ------------------------------------------------ From c1bcfaca0261b40cb4c0daf34d72a7f527c7f2e4 Mon Sep 17 00:00:00 2001 From: Yann1cks <50637827+yann1cks@users.noreply.github.com> Date: Sun, 3 Nov 2024 08:15:25 +0100 Subject: [PATCH 4/4] fix 404 again --- docs/conf.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 09f89679..a9a74451 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -133,8 +133,7 @@ # Remove default url prefix on 404 pages # https://sphinx-notfound-page.readthedocs.io/en/latest/configuration.html#confval-notfound_urls_prefix -#notfound_urls_prefix = "/test/", -notfound_no_urls_prefix = True +notfound_urls_prefix = None notfound_context = { "title": "Page Not Found (404)",