chore: update deploy docs action

authlib · Apr 14, 2024 · 347cc2e · 347cc2e
1 parent 6741f5d
commit 347cc2e
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 53 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,37 +1,31 @@
 name: Publish docs
 
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
 
 on:
   push:
     branches:
       - main
-    tags:
-      - "1.*"
     paths-ignore:
       - ".github/*"
       - "tests/*"
 
-env:
-  VERSION_PATH: dev
-
 jobs:
-  publish:
+  build:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        language: [ "en", "zh" ]
-
     steps:
-      - name: update VERSION_PATH
-        if: ${{ startsWith(github.ref, 'refs/tags/') }}
-        run: echo VERSION_PATH=v$(echo $GITHUB_REF | cut -d / -f 3 | cut -d . -f 1) >> $GITHUB_ENV
-
-      - uses: actions/checkout@v3
-
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
@@ -44,14 +38,24 @@ jobs:
         run: pip install .
 
       - name: sphinx build
-        run: make build-docs -e lang=${{ matrix.language }}
-        env:
-          REF_NAME: ${{ github.ref_name }}
-          REF_TYPE: ${{ github.ref_type }}
-          REPOSITORY: ${{ github.repository }}
-
-      - name: deploy
-        uses: JamesIves/github-pages-deploy-action@v4
+        run: |
+          make build-docs -e lang=en
+          make build-docs -e lang=zh
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          folder: build/${{ matrix.language }}
-          target-folder: ${{ matrix.language }}/${{ env.VERSION_PATH }}/
+          path: public
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4
diff --git a/Makefile b/Makefile
@@ -1,13 +1,13 @@
 lang=en
 
 dev-docs:
-	sphinx-build docs public/${lang}/dev -D language=${lang} -b dirhtml -a
+	sphinx-build docs public/${lang} -D language=${lang} -b dirhtml -a
 
 
 build-docs:
-	@sphinx-build docs build/${lang} -D language=${lang} -b dirhtml
-	@rm build/${lang}/.buildinfo
-	@rm -r build/${lang}/.doctrees
+	@sphinx-build docs public/${lang} -D language=${lang} -b dirhtml
+	@rm public/${lang}/.buildinfo
+	@rm -r public/${lang}/.doctrees
 
 
 clean-docs:

diff --git a/docs/conf.py b/docs/conf.py
@@ -40,14 +40,9 @@
 html_favicon = "_static/icon.svg"
 
 html_theme_options = {
+    "accent_color": "blue",
     "light_logo": "_static/light-logo.svg",
     "dark_logo": "_static/dark-logo.svg",
-    "light_css_variables": {
-        "--sy-rc-theme": "62,127,203",
-    },
-    "dark_css_variables": {
-        "--sy-rc-theme": "102,173,255",
-    },
     "twitter_site": "authlib",
     "twitter_creator": "lepture",
     "twitter_url": "https://twitter.com/authlib",
@@ -80,27 +75,21 @@
     ]
 }
 
-html_baseurl = "https://jose.authlib.org/en/dev/"
+html_baseurl = "https://jose.authlib.org/en/"
 html_context = {
     "source_type": "github",
     "source_user": "authlib",
     "source_repo": "joserfc",
     "source_docs_path": "/docs/",
 }
 
+
 def setup(app):
-    import os
     global language, html_baseurl
 
     language = app.config.language
-    ref_name = os.getenv("REF_NAME")
-    if ref_name and ref_name.startswith("1."):
-        version_path = "v1"
-    else:
-        version_path = "dev"
-
-    html_baseurl = f"https://jose.authlib.org/{language}/{version_path}/"
+    html_baseurl = f"https://jose.authlib.org/{language}/"
     html_context["languages"] = [
-        ("English", f"https://jose.authlib.org/en/{version_path}/%s/", "en"),
-        ("简体中文", f"https://jose.authlib.org/zh/{version_path}/%s/", "zh"),
+        ("English", f"https://jose.authlib.org/en/%s/", "en"),
+        ("简体中文", f"https://jose.authlib.org/zh/%s/", "zh"),
     ]
diff --git a/public/index.html b/public/index.html
@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<meta charset="utf-8">
+<title>Redirecting to https://jose.authlib.org/en/</title>
+<meta http-equiv="refresh" content="0; URL=https://jose.authlib.org/en/">
+<link rel="canonical" href="https://jose.authlib.org/en/">
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -1,4 +1,4 @@
-sphinx==6.2.1
-sphinx-design==0.4.1
-sphinx-copybutton==0.5.2
+Sphinx
+sphinx-design
+sphinx-copybutton
 shibuya
diff --git a/serve.py b/serve.py
@@ -5,4 +5,4 @@
 app.watch("docs/*.rst", shell("make dev-docs"), delay=2)
 app.watch("docs/*/*.rst", shell("make dev-docs"), delay=2)
 app.watch("docs/locales/zh/LC_MESSAGES/*.po", shell("make dev-docs -e lang=zh"), delay=2)
-app.serve(root="build")
+app.serve(root="public")