Skip to content

Commit 6611d92

Browse files
committed
Switch from mkdocs to Jupyter Book v2
Remove mkdocs.yml, add myst.yml for Jupyter Book v2 / MyST-MD. Update docs.yml workflow to use jupyter-book>=2 with Node.js. Add jupyter-book ^2.0.0 as docs dependency in pyproject.toml. Add TMS credentials example to _toc.yml.
1 parent 39be3b0 commit 6611d92

6 files changed

Lines changed: 858 additions & 483 deletions

File tree

.github/workflows/docs.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,24 @@ jobs:
2626
with:
2727
python-version: "3.12"
2828

29+
- name: Set up Node.js
30+
uses: actions/setup-node@v4
31+
with:
32+
node-version: "22"
33+
2934
- name: Install dependencies
3035
run: |
31-
pip install "jupyter-book<1"
36+
pip install "jupyter-book>=2"
3237
pip install .
3338
3439
- name: Build the book
3540
run: |
36-
jupyter-book build . --path-output out
41+
jupyter-book build --html
3742
3843
- name: Upload artifact
3944
uses: actions/upload-pages-artifact@v3
4045
with:
41-
path: ./out/_build/html
46+
path: ./_build/html
4247

4348
deploy:
4449
environment:

_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ parts:
2020
- file: docs/examples/mpm
2121
- file: docs/examples/opensees
2222
- file: docs/examples/openfoam
23+
- file: docs/examples/tms_credentials
2324
- file: docs/examples/database
2425
- caption: API Reference
2526
chapters:

mkdocs.yml

Lines changed: 0 additions & 104 deletions
This file was deleted.

myst.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
version: 1
2+
project:
3+
title: DAPI - DesignSafe API
4+
authors:
5+
- name: Krishna Kumar
6+
email: krishnak@utexas.edu
7+
- name: Pedro Arduino
8+
email: parduino@uw.edu
9+
- name: Scott Brandenberg
10+
email: sjbrandenberg@ucla.edu
11+
copyright: "2024"
12+
github: https://github.com/DesignSafe-CI/dapi
13+
license: MIT
14+
toc:
15+
- file: docs/index.md
16+
- title: Getting Started
17+
children:
18+
- file: docs/installation.md
19+
- file: docs/authentication.md
20+
- file: docs/quickstart.md
21+
- title: User Guide
22+
children:
23+
- file: docs/jobs.md
24+
- file: docs/database.md
25+
- title: Examples
26+
children:
27+
- file: docs/examples.md
28+
- file: docs/examples/apps.md
29+
- file: docs/examples/mpm.md
30+
- file: docs/examples/opensees.md
31+
- file: docs/examples/openfoam.md
32+
- file: docs/examples/tms_credentials.md
33+
- file: docs/examples/database.md
34+
- title: API Reference
35+
children:
36+
- file: docs/api/index.md
37+
- file: docs/api/client.md
38+
- file: docs/api/jobs.md
39+
- file: docs/api/files.md
40+
- file: docs/api/apps.md
41+
- file: docs/api/systems.md
42+
- file: docs/api/database.md
43+
- file: docs/api/auth.md
44+
- file: docs/api/exceptions.md
45+
exclude:
46+
- _build/**
47+
- out/**
48+
- "**.ipynb_checkpoints"
49+
- examples/**
50+
- README.md
51+
- AUTHORS.md
52+
- LICENSE.md
53+
site:
54+
template: book-theme
55+
options:
56+
logo: docs/nheri.png
57+
favicon: docs/favicon.ico

0 commit comments

Comments
 (0)