Merge branch 'main' into rebuild-english

Author: termoshtt

README.md

@@ -10,3 +10,42 @@ Public repository for the JijModeling project.
 - Note that JijModeling is not an OSS project, and source code is not available.
 - This repository is for documentation and learning resources.
   - The contents of this repository (not including `jijmodeling` itself) are CC0 public domain.
+
+Build Jupyter Book
+-------------------
+
+There are Jupyter Books in both Japanese and English.
+
+| Language | Path | GitHub Pages |
+|----------|------|--------------|
+| English  | [docs/en](./docs/en) | [![Book-EN](https://img.shields.io/badge/Book-English-blue)](https://jij-inc.github.io/JijModeling-Tutorials/en) |
+| 日本語   | [docs/ja](./docs/ja) | [![Book-JA](https://img.shields.io/badge/Book-日本語-blue)](https://jij-inc.github.io/JijModeling-Tutorials/ja) |
+
+Each notebook is managed independently and translated manually.
+
+### Build
+
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/) and [task](https://taskfile.dev/installation/).
+
+```shell
+task book_ja
+```
+
+This command builds the Japanese version of the book in `docs/ja/_build/html` and automatically opens it in the browser. To only build the book, use `build_book_ja` task instead. Available tasks are as follows:
+
+```text
+$ task -l
+task: Available tasks for this project:
+* book_en:                 Build and open the English version of the book
+* book_en_all:             Build and open the English version of the book (force rebuild all notebooks)
+* book_ja:                 Build and open the Japanese version of the book
+* book_ja_all:             Build and open the Japanese version of the book (force rebuild all notebooks)
+* build_book_en:           Build the English version of the book
+* build_book_en_all:       Build the English version of the book (force rebuild all notebooks)
+* build_book_ja:           Build the Japanese version of the book
+* build_book_ja_all:       Build the Japanese version of the book (force rebuild all notebooks)
+* open_book_en:            Open the English version of the book
+* open_book_ja:            Open the Japanese version of the book
+* watch_book_en:           Watch English notebooks and auto-rebuild of the book
+* watch_book_ja:           Watch Japanese notebooks and auto-rebuild of the book
+```

Taskfile.yml

@@ -0,0 +1,68 @@
+# https://taskfile.dev
+# yaml-language-server: $schema=https://taskfile.dev/schema.json
+version: "3"
+
+tasks:
+  build_book_ja:
+    desc: Build the Japanese version of the book
+    cmds:
+      - uv run jupyter-book build docs/ja
+
+  build_book_ja_all:
+    desc: Build the Japanese version of the book (force rebuild all notebooks)
+    cmds:
+      - uv run jupyter-book build docs/ja --all
+
+  open_book_ja:
+    desc: Open the Japanese version of the book
+    cmds:
+      - uv run python -m webbrowser file:///$(pwd)/docs/ja/_build/html/index.html
+
+  watch_book_ja:
+    desc: Watch Japanese notebooks and auto-rebuild of the book
+    cmds:
+      - fswatch -o docs/ja/**/*.ipynb | xargs -n1 -I{} jupyter-book build docs/ja
+
+  book_ja:
+    desc: Build and open the Japanese version of the book
+    cmds:
+      - task: build_book_ja
+      - task: open_book_ja
+
+  book_ja_all:
+    desc: Build and open the Japanese version of the book (force rebuild all notebooks)
+    cmds:
+      - task: build_book_ja_all
+      - task: open_book_ja
+
+  build_book_en:
+    desc: Build the English version of the book
+    cmds:
+      - uv run jupyter-book build docs/en
+
+  build_book_en_all:
+    desc: Build the English version of the book (force rebuild all notebooks)
+    cmds:
+      - uv run jupyter-book build docs/en --all
+
+  open_book_en:
+    desc: Open the English version of the book
+    cmds:
+      - uv run python -m webbrowser file:///$(pwd)/docs/en/_build/html/index.html
+
+  watch_book_en:
+    desc: Watch English notebooks and auto-rebuild of the book
+    cmds:
+      - fswatch -o docs/en/**/*.ipynb | xargs -n1 -I{} jupyter-book build docs/en
+
+  book_en:
+    desc: Build and open the English version of the book
+    cmds:
+      - task: build_book_en
+      - task: open_book_en
+
+  book_en_all:
+    desc: Build and open the English version of the book (force rebuild all notebooks)
+    cmds:
+      - task: build_book_en_all
+      - task: open_book_en

docs/en/_config.yml

@@ -21,9 +21,9 @@ bibtex_bibfiles:
 
 # Information about where the book exists on the web
 repository:
-  url: https://github.com/Jij-Inc/JijModeling-Tutorials  # Online location of your book
-  path_to_book: en  # Optional path to your book, relative to the repository root
-  branch: main  # Which branch of the repository should be used when creating links (optional)
+  url: https://github.com/Jij-Inc/JijModeling-Tutorials # Online location of your book
+  path_to_book: docs/en # Optional path to your book, relative to the repository root
+  branch: main # Which branch of the repository should be used when creating links (optional)
 
 # Add GitHub buttons to your book
 # See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository

docs/ja/_config.yml

@@ -21,9 +21,9 @@ bibtex_bibfiles:
 
 # Information about where the book exists on the web
 repository:
-  url: https://github.com/Jij-Inc/JijModeling-Tutorials  # Online location of your book
-  path_to_book: docs  # Optional path to your book, relative to the repository root
-  branch: main  # Which branch of the repository should be used when creating links (optional)
+  url: https://github.com/Jij-Inc/JijModeling-Tutorials # Online location of your book
+  path_to_book: docs/ja # Optional path to your book, relative to the repository root
+  branch: main # Which branch of the repository should be used when creating links (optional)
 
 # Add GitHub buttons to your book
 # See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository