Python API¶
builder module¶
-
class
crl.doc.crldocbuilder.
CRLDocBuilder
(args)[source]¶ CRLDocBuilder generates Sphinx documentation source from Robot Framework test libraries as default. Document type can be filtered with argument if not all the 3 types (builtin, api, crl) needed
Example usage:
- CRLDockBuilder().create_doc()
- CRLDockBuilder().create_doc([‘crl’, ‘builtin’])
Note
This tool does not generated the final documentation. The Spinx configuration files (e.g. conf.py and index.rst) must be strored either before or after the generation into sphinxdocs directory prior Sphinx build.
utils module¶
-
crl.doc.crldocutils.
crl_convert_xml_to_rst
(src_file, dst_file, template_file, author, maintainer, version=None)[source]¶ Converts xml file to rst template
-
crl.doc.crldocutils.
generate_builtin_doc
(builtin_lib_name, templates, xml_dir, rst_dir)[source]¶ Function generate builtin documentation
-
crl.doc.crldocutils.
generate_rflibrary_doc
(lib_path, templates, xml_dir, rst_dir)[source]¶ Generate Rst file for the provided RobotFramework Library file.
Parameters: - lib_path – The absolute path to the library file
- templates – The template to be used for rst file generation
- rst_dir – The path to the rst files’ folder
- xml_dir – The path to the xml files’ folder