Skip to content

Commit f07259c

Browse files
Merge pull request #189 from matthiaskoenig/sbmlsim2
updated documentation
2 parents 80dfc49 + 929c14b commit f07259c

31 files changed

+2055
-553
lines changed

README.md

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Features include among others
2222
- sensitivity analysis
2323

2424
Documentation is available from [https://matthiaskoenig.github.io/sbmlsim/](https://matthiaskoenig.github.io/sbmlsim/).
25+
2526
If you have any questions or issues please [open an issue](https://github.com/matthiaskoenig/sbmlsim/issues).
2627

2728
## Installation
@@ -54,29 +55,4 @@ A Systems Medicine Approach)" by grant number 436883643 and by grant number
5455
Matthias König was supported by the Federal Ministry of Education and Research (BMBF, Germany)
5556
within the research network Systems Medicine of the Liver (LiSyM, grant number 031L0054).
5657

57-
## Development
58-
### Install dev dependencies:
59-
To setup everything for the develop environment use
60-
```bash
61-
# install core dependencies
62-
uv sync
63-
# install dev dependencies
64-
uv pip install -r pyproject.toml --extra dev
65-
uv tool install tox --with tox-uv
66-
uv pip install pre-commit
67-
pre-commit install
68-
pre-commit run
69-
```
70-
71-
### Testing
72-
Testing is performed with tox
73-
Run single tox target
74-
```bash
75-
tox r -e py314
76-
```
77-
Run all tests in parallel
78-
```bash
79-
tox run-parallel
80-
```
81-
8258
© 2019-2026 Matthias König

_docs/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,15 @@
44
cd _docs
55
```
66

7+
quarto add machow/quartodoc
8+
9+
# For deployment
10+
```bash
11+
quartodoc build && quarto render
12+
```
13+
14+
# For development
715
```bash
8-
quartodoc build
9-
quarto render
16+
quartodoc build --watch
17+
quarto preview
1018
```
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.html
2+
*.pdf
3+
*_files/
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
title: Interlinks
2+
author: Michael Chow
3+
version: 1.1.0
4+
quarto-required: ">=1.2.0"
5+
contributes:
6+
filters:
7+
- interlinks.lua

0 commit comments

Comments
 (0)