diff options
| author | Joey Yakimowich-Payne <jyapayne@gmail.com> | 2020-05-04 08:07:36 -0600 |
|---|---|---|
| committer | genotrance <dev@genotrance.com> | 2020-05-04 16:43:07 -0500 |
| commit | 36c7331749a3f2ef87d64edf8dcaed4b79d434fb (patch) | |
| tree | 9c2c83a266c7b9f3fa24000c12a49c52710f1e5b | |
| parent | 5104eeb5c0da96509c621202ea9e94c371e20933 (diff) | |
| download | nimterop-36c7331749a3f2ef87d64edf8dcaed4b79d434fb.tar.gz nimterop-36c7331749a3f2ef87d64edf8dcaed4b79d434fb.zip | |
Add nimArgs to buildDocs docstring
| -rw-r--r-- | nimterop/docs.nim | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/nimterop/docs.nim b/nimterop/docs.nim index 798df52..d5bd50c 100644 --- a/nimterop/docs.nim +++ b/nimterop/docs.nim @@ -45,6 +45,8 @@ proc buildDocs*(files: openArray[string], path: string, baseDir = getProjectPath ## `defines` is a list of `-d:xxx` define flags (the `xxx` part) that should be passed ## to `nim doc` so that `getHeader()` is invoked correctly. ## + ## `nimArgs` is a string representing extra arguments to send to the `nim doc` call. + ## ## Use the `--publish` flag with nimble to publish docs contained in ## `path` to Github in the `gh-pages` branch. This requires the ghp-import ## package for Python: `pip install ghp-import` |