Skip to content

Commit 0c91e1d

Browse files
authored
Merge pull request #41 from bcdev/improve_config_docs
Improved readability of generated configuration reference
2 parents d9c8063 + 0f99fff commit 0c91e1d

File tree

5 files changed

+464
-404
lines changed

5 files changed

+464
-404
lines changed

docs/about.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,14 @@ mkdocs serve
6464
mkdocs gh-deploy
6565
```
6666

67+
If the configuration JSON schema in `zappend/config/schema.py` changes
68+
then the configuration reference documentation `docs/config.md` must be
69+
regenerated:
70+
71+
```bash
72+
zappend --help-config md > docs/config.md
73+
```
74+
6775
## License
6876

6977
`zappend` is open source made available under the terms and conditions of the

0 commit comments

Comments
 (0)