diff --git a/compiler/options.nim b/compiler/options.nim index 10fbab2275167..6471497951c3a 100644 --- a/compiler/options.nim +++ b/compiler/options.nim @@ -261,9 +261,7 @@ type implicitIncludes*: seq[string] # modules that are to be implicitly included docSeeSrcUrl*: string # if empty, no seeSrc will be generated. \ # The string uses the formatting variables `path` and `line`. - docRoot*: AbsoluteDir - # `nim doc --docRoot:foo --project --outdir:docs foo/sub/main.nim` - # genrates: docs/sub/main.html + docRoot*: AbsoluteDir ## see nim --fullhelp for --docRoot # the used compiler cIncludes*: seq[AbsoluteDir] # directories to search for included files diff --git a/doc/advopt.txt b/doc/advopt.txt index d53acc111d06d..64a25b9e5a23f 100644 --- a/doc/advopt.txt +++ b/doc/advopt.txt @@ -67,6 +67,8 @@ Advanced options: --clib:LIBNAME link an additional C library (you should omit platform-specific extensions) --project document the whole project (doc2) + --docRoot:path nim doc --docRoot:foo --project --outdir:docs foo/sub/main.nim + generates: docs/sub/main.html --docSeeSrcUrl:url activate 'see source' for doc and doc2 commands (see doc.item.seesrc in config/nimdoc.cfg) --docInternal also generate documentation for non-exported symbols