Command line interface¶
- Documentation generator script. Documents are generated from:
- Robot Framework built-in libraries,
- installed Common Robot Library packages,
- The ReStructuredText documentation source is generated to the following relative directories:
- sphinxdocs/builtin : Robot Framework built-in keywords.
- sphinxdocs/crl : Common Robot Libraries Robot Framework keyword documentation.
usage: crl_doc_generate_rst [-h] [--version] [-d {crl,builtin,api,all}]
[-l LIBPATH] [-r RESOURCE]
Named Arguments¶
--version | show program’s version number and exit |
-d, --docspec | Possible choices: crl, builtin, api, all Documentation type filter usage example:
without giving this option all types will be generated |
-l | Root paths to the directories from where robotdocsconf.py files are are searched. Each configuration file must contain the following attributes:
Example of robotdocsconf.py file content:
|
-r | Root paths to Robot Framework resource and test case files ending with .robot |