Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
36 changes: 36 additions & 0 deletions .github/workflows/pages-redirect.yml
Original file line number Diff line number Diff line change
@@ -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
26 changes: 26 additions & 0 deletions pages-redirect/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="robots" content="noindex">
<title>QTSurfer reference documentation has moved</title>
<link rel="canonical" href="https://www.qtsurfer.com/reference/sdk-python/latest/">
<noscript><meta http-equiv="refresh" content="0; url=https://www.qtsurfer.com/reference/sdk-python/latest/"></noscript>
<script>
(function () {
var base = "https://www.qtsurfer.com/reference/sdk-python/latest/";
var prefix = "/sdk-python/";
var path = location.pathname;
var rest = path.indexOf(prefix) === 0 ? path.slice(prefix.length) : "";
rest = rest.replace(/^\/+/, "");
location.replace(base + rest + location.search + location.hash);
})();
</script>
<style>body{font:16px/1.5 system-ui,sans-serif;margin:2rem auto;max-width:36rem;padding:0 1rem}</style>
</head>
<body>
<p>The reference documentation of <code>sdk-python</code> now lives at
<a href="https://www.qtsurfer.com/reference/sdk-python/latest/">www.qtsurfer.com/reference/sdk-python/latest/</a>.</p>
</body>
</html>
26 changes: 26 additions & 0 deletions pages-redirect/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="robots" content="noindex">
<title>QTSurfer reference documentation has moved</title>
<link rel="canonical" href="https://www.qtsurfer.com/reference/sdk-python/latest/">
<noscript><meta http-equiv="refresh" content="0; url=https://www.qtsurfer.com/reference/sdk-python/latest/"></noscript>
<script>
(function () {
var base = "https://www.qtsurfer.com/reference/sdk-python/latest/";
var prefix = "/sdk-python/";
var path = location.pathname;
var rest = path.indexOf(prefix) === 0 ? path.slice(prefix.length) : "";
rest = rest.replace(/^\/+/, "");
location.replace(base + rest + location.search + location.hash);
})();
</script>
<style>body{font:16px/1.5 system-ui,sans-serif;margin:2rem auto;max-width:36rem;padding:0 1rem}</style>
</head>
<body>
<p>The reference documentation of <code>sdk-python</code> now lives at
<a href="https://www.qtsurfer.com/reference/sdk-python/latest/">www.qtsurfer.com/reference/sdk-python/latest/</a>.</p>
</body>
</html>
Loading