Merge branch 'main' into doc/github-actions

Author: tkoyama010

.all-contributorsrc

@@ -501,7 +501,8 @@
       "profile": "https://github.com/miguelalizo",
       "contributions": [
         "code",
-        "review"
+        "review",
+        "doc"
       ]
     },
     {
@@ -688,7 +689,8 @@
       "profile": "http://robpasmue.github.io",
       "contributions": [
         "code",
-        "review"
+        "review",
+        "translation"
       ]
     },
     {
@@ -748,7 +750,8 @@
       "profile": "https://github.com/Revathyvenugopal162",
       "contributions": [
         "code",
-        "review"
+        "review",
+        "doc"
       ]
     },
     {
@@ -758,8 +761,29 @@
       "profile": "https://github.com/tkoyama010",
       "contributions": [
         "code",
+        "review",
+        "doc",
+        "translation"
+      ]
+    },
+    {
+      "login": "willingc",
+      "name": "Carol Willing",
+      "avatar_url": "https://avatars.githubusercontent.com/u/2680980?v=4",
+      "profile": "https://hachyderm.io/web/@willingc",
+      "contributions": [
         "review"
       ]
+    },
+    {
+      "login": "kozo2",
+      "name": "Kozo Nishida",
+      "avatar_url": "https://avatars.githubusercontent.com/u/12192?v=4",
+      "profile": "https://github.com/kozo2",
+      "contributions": [
+        "review",
+        "translation"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/build-book.yml

@@ -15,57 +15,57 @@ jobs:
   build-test-book:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Setup Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.9'
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
 
-    - name: Upgrade pip
-      run: |
-        # install pip=>20.1 to use "pip cache dir"
-        python3 -m pip install --upgrade pip
-    - name: Get pip cache dir
-      id: pip-cache
-      run: echo "::set-output name=dir::$(pip cache dir)"
+      - name: Upgrade pip
+        run: |
+          # install pip=>20.1 to use "pip cache dir"
+          python3 -m pip install --upgrade pip
+      - name: Get pip cache dir
+        id: pip-cache
+        run: echo "::set-output name=dir::$(pip cache dir)"
 
-    - name: Cache dependencies
-      uses: actions/cache@v4
-      with:
-        path: ${{ steps.pip-cache.outputs.dir }}
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
 
-    - name: Install dependencies
-      run: python3 -m pip install nox
+      - name: Install dependencies
+        run: python3 -m pip install nox
 
-    - name: Build book
-      run: nox -s docs-test
+      - name: Build book
+        run: nox -s docs-test
 
-    # Save html as artifact
-    - name: Save book html as artifact for viewing
-      uses: actions/upload-artifact@v4
-      with:
-        name: book-html
-        path: |
-          _build/html/
+      # Save html as artifact
+      - name: Save book html as artifact for viewing
+        uses: actions/upload-artifact@v4
+        with:
+          name: book-html
+          path: |
+            _build/html/
 
-    # Push the book's HTML to github-pages
-    - name: Push to GitHub Pages
-      # Only push if on main branch
-      if: github.ref == 'refs/heads/main'
-      uses: peaceiris/actions-gh-pages@v3.8.0
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./_build/html
+      # Push the book's HTML to github-pages
+      - name: Push to GitHub Pages
+        # Only push if on main branch
+        if: github.ref == 'refs/heads/main'
+        uses: peaceiris/actions-gh-pages@v3.8.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./_build/html
 
-    # Test for bad links and ensure alt tags for usability
-    - name: Check HTML using htmlproofer
-      uses: chabad360/htmlproofer@master
-      with:
-        directory: '_build/html'
-        arguments: |
-          --ignore-files "/.+\/_static\/.+/,/genindex.html/"
-          --ignore-status-codes "404, 403, 429, 503"
+      # Test for bad links and ensure alt tags for usability
+      - name: Check HTML using htmlproofer
+        uses: chabad360/htmlproofer@master
+        with:
+          directory: "_build/html"
+          arguments: |
+            --ignore-files "/.+\/_static\/.+/,/genindex.html/"
+            --ignore-status-codes "404, 403, 429, 503"

.pre-commit-config.yaml

@@ -12,7 +12,6 @@
 # - Register git hooks: pre-commit install --install-hooks
 
 repos:
-
   # Misc commit checks
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
@@ -28,23 +27,29 @@ repos:
   - repo: https://github.com/codespell-project/codespell
     rev: v2.3.0
     hooks:
-    - id: codespell
-      additional_dependencies:
-        - tomli
-      exclude: >
-        (?x)^(
-            (.*vale-styles.*)|(.*\.po)
-        )$
+      - id: codespell
+        additional_dependencies:
+          - tomli
+        exclude: >
+          (?x)^(
+              (.*vale-styles.*)|(.*\.po)
+          )$
 
   - repo: https://github.com/errata-ai/vale
     rev: v3.7.0
     hooks:
-    - id: vale
+      - id: vale
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
+    hooks:
+      - id: prettier
+        types_or: [yaml, html, css, scss, javascript, json, toml]
 
 ci:
-    autofix_prs: false
-    #skip: [flake8, end-of-file-fixer]
-    autofix_commit_msg: |
-        '[pre-commit.ci 🤖] Apply code format tools to PR'
-    # Update hook versions every month (so we don't get hit with weekly update pr's)
-    autoupdate_schedule: monthly
+  autofix_prs: false
+  #skip: [flake8, end-of-file-fixer]
+  autofix_commit_msg: |
+    '[pre-commit.ci 🤖] Apply code format tools to PR'
+  # Update hook versions every month (so we don't get hit with weekly update pr's)
+  autoupdate_schedule: monthly