aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--nimterop/docs.nim2
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`