Package: robotframework-libtoc
Robot Framework LibTOCWhat it doesThis tool generates docs using Robot FrameworkLibdocfor an entire folder with Robot Framework resources/libs and creates a TOC (table of contents) file for themWhy use itThe Robot Framework Libdoc tool normally generates a HTML file for a single keyword library or a resource file.
If you have several keyword libraries, you just get several separate HTML files.This tool collects separate keyword documentation files in one place and creates a TOC (table of contents) page
with links to these files.The result is a folder with several static HTML pages which can be placed somewhere
in the intranet or uploaded as CI artifact - so everybody can easily access the keywords docs.Here is the example screenshotHow it worksThe tool goes through the specified folder with RF resources and it'sdirectsubfoldersIt looks for theconfig filesnamed.libtocwhich contain items you would like to create docs for:Paths to resource files inglob formatInstalled RF libraries - names and necessary import params like described inlibdoc user guideOther libdoc CLI options (e.g. version or name of the output file) are not supportedThen it generates the docs usinglibdoc- both for files paths, resolved from the glob patterns, and for the installed libraries. The created HTML files are placed in thelibtoc output_dir- keeping the original subfolder structure of resourcesFinally it generates aTOC (Table of Contents)HTML page with links to all the generated HTML files.
The navigation tree structure in the TOC repeats the folder tree structure.Example of a.libtocconfig file[paths]
# Use glob patterns
**/*.robot
**/*.resource
**/*.py

[libs]
# Use RF library names with params - like for libdoc
SeleniumLibrary
Remote::http://10.0.0.42:8270
# You can use environment variables in lib params
SomeLib::$some_env_var/somepathThe config file must contain at least one of the sections -[paths],[libs]or bothHow to install itSystem requirementsPython >=3.7Robot FrameworkInstallation using pippipinstallrobotframework-libtocHow to use itCreate the.libtocconfig files in theroot of the resources folderand/or indirect subfolderswhere you need docs to be created.Runlibtoc. The lastresources_dirparameter is mandatory, others are optional:-d, --output_dir--config_file--toc_file--toc_template--homepage_template-P, --pythonpathExamples:libtocexample_resources
libtoc--output_dirdocsexample_resources
libtoc--output_dirdocs--toc_fileMY_SPECIAL_NAME_FOR_DOCS.htmlexample_resources
libtoc--toc_templateMY_CUSTOM_TOC.html--homepage_templateMY_CUSTOM_HOMEPAGE.htmlexample_resourcesOpen the created file, e.g.docs\keyword_docs.htmlHow to change the TOC and the homepage HTML templatesThe default HTML template files are located in the python installation directory (usually something like<python_dir>\lib\site-packages\robotframework_libtoc) and can be changed if necessary.It's also possible to provide custom HTML template files using the--toc_templateand--homepage_templateoptions.How to set the Python PathThere are two ways to extend the list of paths where the libraries are searched for:Using the--pythonpathoptionSet thePYTHONPATHenvironment variableSee more inRobot Framework User Guide.