diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 335c3ee..a5a7298 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -40,29 +40,3 @@ jobs: - run: uv sync - run: uv run python -m build - run: uv run twine check dist/* - - docs: - name: publish pdoc to GitHub Pages - runs-on: ubuntu-latest - needs: test - if: github.ref == 'refs/heads/main' - permissions: - contents: read - pages: write - id-token: write - environment: - name: github-pages - url: ${{ steps.deploy.outputs.page_url }} - steps: - - uses: actions/checkout@v4 - - uses: astral-sh/setup-uv@v5 - with: - enable-cache: true - - run: uv sync - - run: ./scripts/docs.sh - - uses: actions/configure-pages@v5 - - uses: actions/upload-pages-artifact@v3 - with: - path: docs - - id: deploy - uses: actions/deploy-pages@v4 diff --git a/.github/workflows/pages-redirect.yml b/.github/workflows/pages-redirect.yml new file mode 100644 index 0000000..1321d0e --- /dev/null +++ b/.github/workflows/pages-redirect.yml @@ -0,0 +1,36 @@ +name: Pages redirect + +# The reference documentation of this project is published on www.qtsurfer.com. The GitHub Pages site of +# this repository only redirects there, so that the links already published in package metadata and +# release notes keep working. The pages to serve are in pages-redirect/. +on: + push: + branches: [main] + paths: + - pages-redirect/** + - .github/workflows/pages-redirect.yml + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: false + +jobs: + deploy: + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deploy.outputs.page_url }} + steps: + - uses: actions/checkout@v4 + - uses: actions/configure-pages@v5 + - uses: actions/upload-pages-artifact@v3 + with: + path: pages-redirect + - id: deploy + uses: actions/deploy-pages@v4 diff --git a/pages-redirect/404.html b/pages-redirect/404.html new file mode 100644 index 0000000..dc37a32 --- /dev/null +++ b/pages-redirect/404.html @@ -0,0 +1,26 @@ + + + + + + +QTSurfer reference documentation has moved + + + + + + +

The reference documentation of sdk-python now lives at +www.qtsurfer.com/reference/sdk-python/latest/.

+ + diff --git a/pages-redirect/index.html b/pages-redirect/index.html new file mode 100644 index 0000000..dc37a32 --- /dev/null +++ b/pages-redirect/index.html @@ -0,0 +1,26 @@ + + + + + + +QTSurfer reference documentation has moved + + + + + + +

The reference documentation of sdk-python now lives at +www.qtsurfer.com/reference/sdk-python/latest/.

+ +