🪐 Migrated to jupyter book.

This seems to be way better than mkdocs.
rentruewang · Oct 12, 2024 · 80fddca · 80fddca
1 parent 62e96c9
commit 80fddca
Show file tree

Hide file tree

Showing 10 changed files with 47 additions and 48 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -14,18 +14,25 @@ jobs:
           python-version: "3.10"
 
       - name: ⬇️ Python PDM
-        uses: pdm-project/setup-pdm@v3
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: "3.10"
+          cache: true
 
       - name: ⬇️ Python Dependencies
-        run: pdm install
+        run: pdm install -G:all
 
       - name: 🚂 Activate environment
         run: echo "$(pdm venv --path in-project)/bin" >> $GITHUB_PATH
 
-      - name: 📰 Publish docs
-        run: |
-          git config user.name 'github-actions[bot]'
-          git config user.email 'github-actions[bot]@users.noreply.github.com'
+      - name: 🚧 Jupyter build
+        run: jupyter book build docs
 
-      - name: ⬆️ MkDocs deploy
-        run: mkdocs gh-deploy --force
+      - name: 📰 Publish docs
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: ./docs/_build/html
+          git-config-name: "github-actions[bot]"
+          git-config-email: "github-actions[bot]@users.noreply.github.com"
+          commit-message: 🎉 Book deployed
diff --git a/STRATEGY.md b/STRATEGY.md
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
@@ -0,0 +1,2 @@
+```{include} ../CODE_OF_CONDUCT.md
+```
diff --git a/docs/LICENSE.md b/docs/LICENSE.md
diff --git a/docs/LICENSE.md b/docs/LICENSE.md
@@ -0,0 +1,4 @@
+# License
+
+```{include} ../LICENSE.md
+```
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,16 @@
+title: Koila
+author: RenChu Wang
+copyright: RenChu Wang, 2024
+logo: assets/koila.png
+
+exclude_patterns: [_build]
+only_build_toc_files: true
+
+repository:
+  url: https://github.com/rentruewang/koila
+
+html:
+  use_repository_button: true
+
+execute:
+  execute_notebooks: force
diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -0,0 +1,5 @@
+format: jb-article
+root: index
+sections:
+  - file: LICENSE
+  - file: CODE_OF_CONDUCT
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,2 @@
+```{include} ../README.md
+```
diff --git a/mkdocs.yml b/mkdocs.yml
diff --git a/pyproject.toml b/pyproject.toml
@@ -40,6 +40,9 @@ website = [
     "mkdocs-git-revision-date-plugin>=0.3.2",
     "mkdocs-git-revision-date-localized-plugin>=1.2.2",
     "mkdocs-material>=9.5.3",
+    "jupyter>=1.1.1",
+    "jupyter-book>=1.0.3",
+    "myst-parser>=2.0.0",
 ]
 type = [
     "mypy>=1.8.0",