English version of Jupyter Book (#17)

Directory changes
-----------------
- `docs/` -> `docs/ja/`
- `en/` -> `docs/en/`

Redirector
----------
古いURLにアクセスした場合に自動的に `ja/` 以下に誘導します。GitHub Pagesでは完全な301 redirectは出来ないので
`<meta refresh>` で遷移します。`docs/redirect` にHTMLが置いてあり、Actionsで統合されます。

英語版の内容
----------
そのままにしてあります。変更は次以降のPRで行います。

Author: termoshtt

.github/workflows/docs.yml

@@ -7,107 +7,66 @@ on:
   pull_request:
   workflow_dispatch:
 
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
 jobs:
-  docs:
+  book:
     strategy:
       matrix:
-        python-version:
-          - "3.9"
-        os:
-          - ubuntu-latest
-    runs-on: ${{ matrix.os }}
+        lang:
+          - ja
+          - en
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
       - name: Install uv
         uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
 
-      - name: Set up Python
-        run: uv python install ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: uv sync --all-extras --dev
+      - name: Set up Python and dependencies
+        run: |
+          uv python install 3.9
+          uv sync --all-extras --dev
 
       - name: Build the book
         run: |
-          uv run jupyter-book build docs
-          ERROR_LOGS=$(find docs/_build -type f -name "*.err.log")
+          uv run jupyter-book build docs/${{ matrix.lang }}
+          ERROR_LOGS=$(find docs/${{ matrix.lang }}/_build -type f -name "*.err.log")
           if [ -n "$ERROR_LOGS" ]; then while IFS= read -r log; do echo "[ERROR LOG] $log" && cat "$log"; done <<< "$ERROR_LOGS" && exit 1; fi
 
       - name: Upload HTML
         uses: actions/upload-artifact@v4
         with:
-          name: docs
-          path: ./docs/_build/html
+          name: docs-${{ matrix.lang }}
+          path: ./docs/${{ matrix.lang }}/_build/html
           retention-days: 30
 
-      - name: Upload API ref
-        uses: actions/upload-artifact@v4
-        with:
-          name: api
-          path: ./apis
-          retention-days: 30
-  en:
-    strategy:
-      matrix:
-        python-version:
-          - "3.9"
-        os:
-          - ubuntu-latest
-    runs-on: ${{ matrix.os }}
+  package:
+    needs: book
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-
-      - name: Set up Python
-        run: uv python install ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: uv sync --all-extras --dev
+      - name: API reference
+        run: |
+          mkdir -p package
+          mv apis package
 
-      - name: Build the book
-        run: uv run jupyter-book build en
-  
-      - name: Upload HTML
-        uses: actions/upload-artifact@v4
-        with:
-          name: en
-          path: ./en/_build/html
-          retention-days: 30
+      - name: Setup redirect
+        run: mv docs/redirect/* package/
 
-  package:
-    needs: [docs, en]
-    runs-on: ubuntu-latest
-    steps:
       - name: Download HTML of docs
         uses: actions/download-artifact@v4
         with:
-          name: docs
-          path: ./package
-
-      - name: Download HTML of api reference
-        uses: actions/download-artifact@v4
-        with:
-          name: api
-          path: ./package/apis
+          name: docs-ja
+          path: ./package/ja
 
       - name: Download HTML of en
         uses: actions/download-artifact@v4
         with:
-          name: en
+          name: docs-en
           path: ./package/en
 
       - name: Upload Docs Package
@@ -118,6 +77,15 @@ jobs:
           retention-days: 30
 
   deploy:
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+
+    concurrency:
+      group: "pages"
+      cancel-in-progress: false
+
     if: github.ref == 'refs/heads/main'
     needs: package
     environment:
@@ -130,7 +98,7 @@ jobs:
         with:
           name: package
           path: .
-  
+
       - name: Setup Pages
         uses: actions/configure-pages@v5
 

.github/workflows/python.yml

@@ -38,6 +38,5 @@ jobs:
         run: uv sync --all-extras --dev
 
       - name: Run tests
-        run: | 
+        run: |
           uv run jupyter nbconvert --execute --to notebook --inplace docs/**/*.ipynb
-          uv run jupyter nbconvert --execute --to notebook --inplace en/**/*.ipynb

.gitignore

@@ -163,4 +163,5 @@ cython_debug/
 
 .DS_Store
 
-en/_build/
+# Jupyter book
+_build/

en/_config.yml renamed to docs/en/_config.yml

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=ja/getting_started.html" />

en/_toc.yml renamed to docs/en/_toc.yml

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=ja/index.html" />

en/getting_started.ipynb renamed to docs/en/getting_started.ipynb

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=ja/introduction.html" />

docs/logo.png renamed to docs/en/logo.png

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/quickstart/openjij.html" />

docs/references.bib renamed to docs/en/references.bib

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/quickstart/scip.html" />

en/references/cheat_sheet.ipynb renamed to docs/en/references/cheat_sheet.ipynb

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/references/cheat_sheet.html" />

en/references/tips.ipynb renamed to docs/en/references/tips.ipynb

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/references/tips.html" />

docs/releases/assets/jijmodeling-1.10.0_01.png renamed to docs/en/releases/assets/jijmodeling-1.10.0_01.png

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/releases/jijmodeling-1.10.0.html" />

docs/releases/assets/jijmodeling-1.10.0_02.png renamed to docs/en/releases/assets/jijmodeling-1.10.0_02.png

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/releases/jijmodeling-1.10.1.html" />

docs/releases/assets/jijmodeling-1.8.0_01.png renamed to docs/en/releases/assets/jijmodeling-1.8.0_01.png

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/releases/jijmodeling-1.11.0.html" />

docs/releases/jijmodeling-1.10.0.ipynb renamed to docs/en/releases/jijmodeling-1.10.0.ipynb

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/releases/jijmodeling-1.8.0.html" />

docs/releases/jijmodeling-1.10.1.ipynb renamed to docs/en/releases/jijmodeling-1.10.1.ipynb

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/releases/jijmodeling-1.9.0.html" />

docs/releases/jijmodeling-1.11.0.ipynb renamed to docs/en/releases/jijmodeling-1.11.0.ipynb

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/tutorials/constraint_and_penalty.html" />

docs/releases/jijmodeling-1.8.0.ipynb renamed to docs/en/releases/jijmodeling-1.8.0.ipynb

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/tutorials/creating_models.html" />

docs/releases/jijmodeling-1.9.0.ipynb renamed to docs/en/releases/jijmodeling-1.9.0.ipynb

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/tutorials/expressions.html" />

docs/tutorials/assets/creating_models_01.png renamed to docs/en/tutorials/assets/creating_models_01.png

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url=../ja/tutorials/types_and_bounds.html" />