4.44. kink/doc/DOC_PARSE_TOOL¶
Launcheable mod to parse kink doc and generate JSON.
Usage: kink [Kink_options]... mod:kink/doc/DOC_PARSE_TOOL [Mod_options]... Src_dir_path...
The command finds Kink source files of exposed mods from Src_dir_paths. It parses kink doc from the source files, then outputs JSON of the kink doc to the standard output.
Mod_options:
• --title {Title} : gives the title of the kink doc. If not given, the default title is used.
• --overview {Overview_file_path} : gives the file path of the overview file, which contains text blocks of the top level of the kink doc. If not given, no blocks are placed in the top level of the kink doc.
If the command generates JSON successfully, it exits with 0 as the exit status.
If the command fails, it exits with non-zero exit status.
4.44.1. DOC_PARSE_TOOL.main(Argv)¶
main is the launcher fun of the mod.