Merge pull request #31 from Jij-Inc/doc

Again the test has failed because of the settings. So, I'll ignore the test failure and merge this into `main`.

Author: ksk-jij

.github/workflows/jupyter-book-publish.yml

@@ -2,8 +2,8 @@ name: Deploy Jupyter Book to GitHub Pages
 
 on:
   # For now we just use manual trigger.
-  # push:
-  #   branches: ["main"]
+  push:
+    branches: ["main"]
   workflow_dispatch:
 
 permissions:
@@ -38,7 +38,7 @@ jobs:
         shell: bash
         run:  |
           set -eux
-          uv sync --all-extras
+          uv sync --group docs
       # Build the jupyter notebooks.
       - name: Build the book and LP
         run: |
@@ -57,14 +57,16 @@ jobs:
     needs: [build-jupyter-book]
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout  # For getting index.html
+        uses: actions/checkout@v4
       - name: Download all artifacts
         uses: actions/download-artifact@v4
       - name: Create unified site structure
         run: |
           mkdir -p docs/_build/html
           mkdir -p docs/_build/html/en && cp -r doc-jupyter-book-en/* docs/_build/html/en/
           mkdir -p docs/_build/html/ja && cp -r doc-jupyter-book-ja/* docs/_build/html/ja/
-          cp -r docs/_build/html/en/index.html docs/_build/html/index.html
+          cp -r docs/index.html docs/_build/html/index.html
       # Upload the unified site structure as a single artifact.
       - name: Upload artifact
         uses: actions/upload-artifact@v4

docs/en/_config.yml

@@ -62,6 +62,9 @@ sphinx:
       autoapi_ignore:
         - "**/uploader.py"
         - "**/uploader/*"
+        - "**/[0-9][0-9]_*/*"
+        - "**/qoblib/definitions.py"
+        - "**/ommx_quantum_benchmarks/uploader/*"
       autoapi_python_class_content: 'both'
       language: en
       html_search_language: en

docs/en/_toc.yml

@@ -24,7 +24,7 @@ parts:
     chapters:
     - file: tutorial/examples/index_examples
       sections:
-        - file: tutorial/examples/marketsplit_example
+        - file: tutorial/examples/labs_example
 
   - caption: API Reference
     chapters:

docs/en/tutorial/usage/basic_usage.ipynb

@@ -7,7 +7,7 @@
    "source": [
     "# Basic Usage\n",
     "\n",
-    "This page covers common usage patterns and best practices when working with QOBLIB in OMMX format. Please refer [OMMX focumentation](https://jij-inc.github.io/ommx/en/introduction.html) as well."
+    "This page covers common usage patterns and best practices when working with QOBLIB in OMMX format. Please refer [OMMX documentation](https://jij-inc.github.io/ommx/en/introduction.html) as well."
    ]
   },
   {

docs/index.html

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

docs/ja/_config.yml

@@ -62,6 +62,9 @@ sphinx:
       autoapi_ignore:
         - "**/uploader.py"
         - "**/uploader/*"
+        - "**/[0-9][0-9]_*/*"
+        - "**/qoblib/definitions.py"
+        - "**/ommx_quantum_benchmarks/uploader/*"
       autoapi_python_class_content: 'both'
       language: ja
       html_search_language: ja

docs/ja/_toc.yml

@@ -24,7 +24,7 @@ parts:
     chapters:
     - file: tutorial/examples/index_examples
       sections:
-        - file: tutorial/examples/marketsplit_example
+        - file: tutorial/examples/labs_example
 
   - caption: API リファレンス
     chapters: