Dev

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: docs
+
+on:
+  pull_request:
+    branches: ["dev", "v1"]
+  push:
+    branches: ["v1"]
+
+jobs:
+  build-docs:
+    name: Build docs
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+
+    - name: Install doc dependencies
+      run: |
+        pip install ".[docs]"
+
+    - name: Build documentation
+      run: |
+        make doc

Makefile

@@ -23,7 +23,6 @@ gen-example-from-base:
 	cp -r docs/examples/en/* docs/en/examples/
 	cp -r docs/examples/zh/* docs/zh-CN/examples/
 
-# Note the first line relies on jupyterbook==0.11.3
 doc: rm-doc gen-doc-config gen-example-from-base
 	jupyter-book build docs/en/
 	jupyter-book build docs/zh-CN/

docs/en/.readthedocs.yaml

@@ -9,6 +9,7 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.10"
+    nodejs: "22"
   jobs:
     pre_build:
       # Generate on-the-fly Sphinx configuration from Jupyter Book's _config.yml

docs/requirements-doc.txt

@@ -1,5 +1,6 @@
-jupyter-book
+jupyter-book<2
 conflux-web3
 cfx-utils>=1.0.1
+mmg==2.0.0
 sphinx-autodoc-typehints
-# sphinx-design
+# sphinx-design

docs/zh-CN/.readthedocs.yaml

@@ -9,6 +9,7 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.10"
+    nodejs: "22"
   jobs:
     pre_build:
       # Generate on-the-fly Sphinx configuration from Jupyter Book's _config.yml

setup.py

@@ -45,7 +45,7 @@
         # "py-solc>=0.4.0",
         # "pytest>=6.2.5,<7",
         # "sphinx>=4.2.0,<5",
-        "jupyter-book",
+        "jupyter-book<2",
         "mmg==2.0.0",
         "sphinx-autodoc-typehints",
         # "sphinx_rtd_theme>=0.1.9",