nicolas
/
gaspype
mirror of https://github.com/DLR-Institute-of-Future-Fuels/gaspype.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #16 from DLR-Institute-of-Future-Fuels/dev 

CI for building docs fixed
This commit is contained in:
Nicolas Kruse 2026-07-14 10:22:59 +02:00 committed by GitHub
parent 20ae8cddad 75ac3728a3
commit 372ad7fe5a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
examples/README.md
View File

@ -11,11 +11,11 @@ The conversion is done like the following automated by the
[docs/source/render_examples.py](../docs/source/render_examples.py) script:
``` bash
# Converting markdown with code sections to Jupyter Notebook and run it:
notedown examples/soec_methane.md --to notebook --output docs/source/api/soec_methane.ipynb --run
notedown examples/sofc_methane.md --to notebook --output docs/source/api/sofc_methane.ipynb --run
# Converting the Jupyter Notebook to Markdown and a folder with image
# files placed in docs/source/api/:
jupyter nbconvert --to markdown docs/source/api/soec_methane.ipynb --output soec_methane.md
jupyter nbconvert --to markdown docs/source/api/sofc_methane.ipynb --output sofc_methane.md
```
A new example Markdown file can be created from a Jupyter Notebook running

8
pyproject.toml
View File

@ -50,10 +50,10 @@ doc_build = [
"myst-parser",
"pandas",
"matplotlib",
"ipykernel",
"jupyter",
"nbconvert",
"notedown"
"ipykernel==6.29",
"jupyter==1.1",
"nbconvert==7.16",
"notedown==1.5"
]
[tool.mypy]