Skip to content

Commit 25f6b6f

Browse files
authored
Update Documentation Building System (#78)
* Update mkdocs * Move docs requirements to additional dependencies * Add black dependency for API autoformat * Change back to mknotebooks for latex in jupyter
1 parent 0bfc8cb commit 25f6b6f

3 files changed

Lines changed: 12 additions & 9 deletions

File tree

.github/workflows/build_docs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ jobs:
2424
- name: Install dependencies
2525
run: |
2626
python -m pip install --upgrade pip
27-
python -m pip install .
28-
python -m pip install -r docs/requirements.txt
27+
python -m pip install ".[docs]"
2928
3029
- name: Build docs
3130
run: mkdocs build

docs/requirements.txt

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

pyproject.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@ keywords = ["jax", "sciml", "deep-learning", "pde", "etdrk"]
1111
urls = {repository = "https://github.com/Ceyron/exponax" }
1212
dependencies = ["jax>=0.4.13", "jaxtyping>=0.2.20", "typing_extensions>=4.5.0", "equinox>=0.11.3", "matplotlib>=3.8.1"]
1313

14+
[project.optional-dependencies]
15+
docs = [
16+
"mkdocs==1.6.1",
17+
"mkdocs-material==9.7.1",
18+
"mkdocstrings==1.0.3",
19+
"mkdocstrings-python==2.0.1",
20+
"mknotebooks==0.8.0",
21+
"griffe==1.15.0",
22+
"black==26.1.0", # Needed for API autoformat
23+
]
24+
1425
[tool.ruff]
1526
line-length = 88
1627
target-version = "py310"

0 commit comments

Comments
 (0)