jyapayne/nimterop
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add nimArgs to buildDocs docstring

Browse source
This commit is contained in:
Joey Yakimowich-Payne 2020-05-04 08:07:36 -06:00 • committed by genotrance
commit 36c7331749
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
nimterop/docs.nim
View file

@ -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 ## `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. ## 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 ## Use the `--publish` flag with nimble to publish docs contained in
## `path` to Github in the `gh-pages` branch. This requires the ghp-import ## `path` to Github in the `gh-pages` branch. This requires the ghp-import
## package for Python: `pip install ghp-import` ## package for Python: `pip install ghp-import`