diff options
| author | Théo de la Hogue | 2022-11-08 14:56:31 +0100 |
|---|---|---|
| committer | Théo de la Hogue | 2022-11-08 14:56:31 +0100 |
| commit | f5f190abd9eef15316ea92fe6ec42e1abc3bf6ca (patch) | |
| tree | 4006164d855e058c9e6586ff0600417321675d95 /README.md | |
| parent | d061d4729122cf7dbda2f78252826f4c93debc94 (diff) | |
| download | argaze-f5f190abd9eef15316ea92fe6ec42e1abc3bf6ca.zip argaze-f5f190abd9eef15316ea92fe6ec42e1abc3bf6ca.tar.gz argaze-f5f190abd9eef15316ea92fe6ec42e1abc3bf6ca.tar.bz2 argaze-f5f190abd9eef15316ea92fe6ec42e1abc3bf6ca.tar.xz | |
Adding wiki link.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 12 insertions, 1 deletions
@@ -40,7 +40,18 @@ pip install -e . ## Documentation -To generate html documentation using [pdoc](https://pdoc.dev/), +### Wiki + +The [wiki](https://git.recherche.enac.fr/projects/argaze/wiki) provides many explanations about how works ArGaze, what is possible to do and code samples. + +### Cookbook + +The **utils** submodule is a good place to get ready made code examples. + +### Code + +ArGaze code documentation is based on [pdoc](https://pdoc.dev/). +To generate html documentation: - Install 'pdoc' package: |