Skip to content

Commit 5f91b17

Browse files
committed
Add 'Interactive documentation development' section
1 parent fb1c15d commit 5f91b17

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,19 @@ nox -- -k test__normal_command__logged
130130

131131
9. Submit a pull request through the GitHub website.
132132

133+
## Interactive documentation development
134+
135+
Our nox configuration include special session for simplifying documentation
136+
development. When launched, documentation will be re-rendered after any saved
137+
code/documentation files changes. To use this session, after local environment setup,
138+
just run:
139+
140+
```bash
141+
nox -s docs
142+
```
143+
144+
Rendered documentation will be available under: <http://localhost:9812/>
145+
133146
## Style guide
134147

135148
### General guidelines

0 commit comments

Comments
 (0)