feat: update docs build script and tempplate lint action

Author: colyerdeng

docs/gen_home_pages.py

@@ -0,0 +1,14 @@
+"""Generate the home pages."""
+import mkdocs_gen_files
+import os
+
+# Read README.md from project root
+readme_path = os.path.join(os.path.dirname(os.path.dirname(__file__)), "README.md")
+
+# Read the content of README.md
+with open(readme_path, 'r', encoding='utf-8') as f:
+    content = f.read()
+
+# Write the content to index.md in the docs directory
+with mkdocs_gen_files.open("index.md", "w") as f:
+    f.write(content)

docs/gen_ref_pages.py

@@ -1,7 +1,6 @@
 """Generate the code reference pages."""
 
 from pathlib import Path
-
 import mkdocs_gen_files
 
 nav = mkdocs_gen_files.Nav()

docs/index.md

@@ -16,6 +16,7 @@ plugins:
   - gen-files:
       scripts:
         - docs/gen_ref_pages.py
+        - docs/gen_home_pages.py
   - literate-nav:
       nav_file: SUMMARY.md
   - mkdocstrings:

mkdocs.yml

@@ -32,7 +32,6 @@ docs = [
     "mkdocs-gen-files>=0.5.0",
     "mkdocs-literate-nav>=0.6.1",
     "pymdown-extensions>=10.7",
-    "pymdown-extensions>=10.7",
 ]
 
 [project.scripts]

pyproject.toml

@@ -13,17 +13,7 @@ permissions:
   pull-requests: write  # 用于在 PR 中添加评论
 
 jobs:
-  setup:
-    uses: ./.github/workflows/setup.yaml
-    with:
-      install-deps: dev
-      python-version: "{{cookiecutter.max_python_version}}"  # 使用最新版本
-    secrets:
-      OP_SERVICE_ACCOUNT_TOKEN: {% raw %}${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}{% endraw %}
-      PERSONAL_ACCESS_TOKEN: {% raw %}${{ secrets.PERSONAL_ACCESS_TOKEN }}{% endraw %}
-
-  lint:
-    needs: setup
+  check:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -37,12 +27,15 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v5
 
+      - name: Install dependencies
+        run: uv sync --extra=dev
+
       - name: Run lint checks
         id: lint
-        run: uv tool run nox -s lint
+        run: uvx nox -s lint
         continue-on-error: true
 
-      - name: Comment on PR
+      - name: Comment on PR (Lint)
         if: github.event_name == 'pull_request' && steps.lint.outcome == 'failure'
         uses: actions/github-script@v7
         with:
@@ -62,27 +55,20 @@ jobs:
         if: steps.lint.outcome == 'failure'
         run: exit 1
 
-  test-all:
-    needs: setup
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "{{cookiecutter.max_python_version}}"
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v5
-
-      - name: Run tests on all Python versions
+      - name: Run tests
         id: test
-        run: uv tool run nox -s test_all
+        run: uvx nox -s test_all
         continue-on-error: true
 
-      - name: Comment on PR
+      - name: Upload coverage reports
+        if: success()
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage.xml
+          flags: unittests
+
+      - name: Comment on PR (Tests)
         if: github.event_name == 'pull_request' && steps.test.outcome == 'failure'
         uses: actions/github-script@v7
         with:
@@ -101,3 +87,4 @@ jobs:
       - name: Check test result
         if: steps.test.outcome == 'failure'
         run: exit 1
+

repo_scaffold/templates/template-python/{{cookiecutter.project_slug}}/.github/workflows/lint.yaml

@@ -0,0 +1,14 @@
+"""Generate the home pages."""
+import mkdocs_gen_files
+import os
+
+# Read README.md from project root
+readme_path = os.path.join(os.path.dirname(os.path.dirname(__file__)), "README.md")
+
+# Read the content of README.md
+with open(readme_path, 'r', encoding='utf-8') as f:
+    content = f.read()
+
+# Write the content to index.md in the docs directory
+with mkdocs_gen_files.open("index.md", "w") as f:
+    f.write(content)

repo_scaffold/templates/template-python/{{cookiecutter.project_slug}}/docs/gen_home_pages.py

@@ -1,7 +1,6 @@
 """Generate the code reference pages."""
 
 from pathlib import Path
-
 import mkdocs_gen_files
 
 nav = mkdocs_gen_files.Nav()

repo_scaffold/templates/template-python/{{cookiecutter.project_slug}}/docs/gen_ref_pages.py

@@ -16,6 +16,7 @@ plugins:
   - gen-files:
       scripts:
         - docs/gen_ref_pages.py
+        - docs/gen_home_pages.py
   - literate-nav:
       nav_file: SUMMARY.md
   - mkdocstrings: