1
0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00

vdoc: dd .vdocignore + minor fixes

This commit is contained in:
Ned Palacios
2020-06-29 17:03:09 +08:00
committed by GitHub
parent c588bdee5a
commit 025652bb78
6 changed files with 101 additions and 39 deletions

View File

@ -13,13 +13,17 @@ or Markdown format.
Options:
-all Includes private and public functions/methods/structs/consts/enums.
-f Specifies the output format to be used.
-inline-assets Embeds the contents of the CSS and JS assets into the webpage directly.
-l Show the locations of the generated signatures. (For plaintext only)
-h, -help Prints this help text.
-m Generate docs for modules listed in that folder.
-o Specifies the output file/folder path where to store the generated docs.
-readme Include README.md to docs if present.
-v Enables verbose logging. For debugging purposes.
For HTML mode:
-inline-assets Embeds the contents of the CSS and JS assets into the webpage directly.
-open Launches the browser when the server docs has started.
-p Specifies the port to be used for the docs server.
-s Serve HTML-generated docs via HTTP.
-readme Include README.md to docs if present.
-v Enables verbose logging. For debugging purposes.
-h, -help Prints this help text.
For plain text mode:
-l Show the locations of the generated signatures.

View File

@ -79,7 +79,7 @@ fn main_v() {
return
}
'vlib-docs' {
util.launch_tool(prefs.is_verbose, 'vdoc', ['doc', '-m', '-s', os.join_path(os.base_dir(@VEXE), 'vlib')])
util.launch_tool(prefs.is_verbose, 'vdoc', ['doc', 'vlib'])
}
'get' {
println('V Error: Use `v install` to install modules from vpm.vlang.io')