feat: initial commit for simple redirect service

Author: lkstrp

.github/workflows/documentation.yml

@@ -0,0 +1,26 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Sphinx build
+        run: |
+          uv run sphinx-build doc _build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true

.gitignore

@@ -0,0 +1,5 @@
+_build/
+.venv/
+*.pyc
+__pycache__/
+.DS_Store

.python-version

@@ -0,0 +1 @@
+3.13

README.md

@@ -0,0 +1,19 @@
+# Redirect Service
+
+A simple sphinx-based redirect service using `sphinx-reredirects`.
+
+## Available Redirects
+
+See `conf.py` for the list of available redirects.
+
+## Adding Redirects
+
+Edit `conf.py` and add entries to the `redirects` dictionary with a `/index` suffix.
+
+```python
+redirects = {
+    "new-redirect/index": "https://example.com",
+}
+```
+
+This will create a redirect from `https://go.pypsa.org/new-redirect` to `https://example.com` and the url can be used anywhere.

conf.py

@@ -0,0 +1,23 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information -----------------------------------------------------
+project = 'PyPSA Redirects'
+copyright = '2025, PyPSA'
+author = 'PyPSA'
+
+# -- General configuration ---------------------------------------------------
+extensions = [
+    'sphinx_reredirects',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output ------------------------------------------------
+html_theme = 'basic'
+html_static_path = []
+
+# -- Redirects configuration ------------------------------------------------
+redirects = {
+    "test-redirect/index": "https://google.com"
+}

index.rst

@@ -0,0 +1,4 @@
+PyPSA Redirect Service
+======================
+
+See `https://github.com/PyPSA/redirect-service`.

pyproject.toml

@@ -0,0 +1,10 @@
+[project]
+name = "redirect-service"
+version = "0.1.0"
+description = "Simple redirect service"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "sphinx==8.2.3",
+    "sphinx-reredirects==1.0.0",
+]