Skip to content

Commit a6c3b80

Browse files
committed
fixup! QART->QREF rename
1 parent 8bf5974 commit a6c3b80

File tree

8 files changed

+12
-0
lines changed

8 files changed

+12
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,3 +139,6 @@ data = load_some_program()
139139
program = SchemaV1.model_validate(data)
140140
```
141141

142+
## Development
143+
144+
In order to install development environment or build documentation locally, please refer to [Development Guide](TODO).

docs/development.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,12 @@ pip install -e .
3535
highly recommend you use Poetry instead of pip editable install.
3636
Without Poetry, you will need to edit dependencies manually,
3737
which is very error-prone.
38+
39+
## Setting up docs locally
40+
41+
In order to set up docs locally you need to have appropriate dependencies – they get instaled when running `poetry install` automatically. When done, please run:
42+
43+
```bash
44+
mkdocs serve
45+
```
46+
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)