robotframework-libtoc 1.4.0__tar.gz → 1.4.2__tar.gz

{robotframework_libtoc-1.4.0 → robotframework_libtoc-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-libtoc
-Version: 1.4.0
+Version: 1.4.2
 Summary: Docs and TOC generator for Robot Framework resources and libs
 Home-page: https://github.com/amochin/robotframework-libtoc
 License: Apache-2.0
@@ -25,7 +25,7 @@ This tool generates docs using Robot Framework [Libdoc](https://robotframework.o
 
 ## Why use it
 The 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.
+If you have several keyword libraries or resources, 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.   
@@ -38,10 +38,13 @@ in the intranet or uploaded as CI artifact - so everybody can easily access the
 ## How it works
 - The tool goes through the specified folders with RF resources and it's **direct** subfolders
 - It looks for the **config files** named `.libtoc` which contain items you would like to create docs for:
-    1. Paths to resource files in [glob format](https://en.wikipedia.org/wiki/Glob_(programming))
-    2. Paths to resources files in [glob format](https://en.wikipedia.org/wiki/Glob_(programming)) inside packages loaded from the pythonpath
-    3. Installed RF libraries - names and necessary import params like described in [libdoc user guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#general-usage)
+    1. Paths to resource/lib files in [glob format](https://en.wikipedia.org/wiki/Glob_(programming))
+    2. RF libraries, installed or available in PYTHONPATH using the provided fully qualified name
+        > Librariy import params (if necessary) like described in [libdoc user guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#general-usage)
         > Other libdoc CLI options (e.g. version or name of the output file) are not supported
+    3. Paths to resource/lib files in [glob format](https://en.wikipedia.org/wiki/Glob_(programming)) inside Python packages, loaded from the PYTHONPATH
+        > See more about bundling RF resources in Python packages in [RF User Guide](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#taking-resource-files-into-use)
+    
 - Then it generates the docs using `libdoc` - both for files paths, resolved from the glob patterns, and for the installed libraries. The created HTML files are placed in the **libtoc output_dir** - keeping the original subfolder structure of resources
 - Finally it generates a **TOC (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.
@@ -49,19 +52,23 @@ in the intranet or uploaded as CI artifact - so everybody can easily access the
 ```
 [paths]
 # Use glob patterns
-**/*.robot
-**/*.resource
-**/*.py
-
-[packages]
-example_package:resources/**/*.resource
+some-resources/**/*.robot
+some-resources/**/*.resource
+some-resources/**/*.py
 
 [libs]
 # Use RF library names with params - like for libdoc
 SeleniumLibrary
 Remote::http://10.0.0.42:8270
+# Import a library from PYTHONPATH using fully qualified name
+some-libs.mylib.mypy
 # You can use environment variables in lib params
 SomeLib::$some_env_var/somepath
+
+[packages]
+# Use package name in python path and glob patterns separated by :
+some-package:resources/**/*.resource
+some-package:libs/**/*.py
 ```
 > The config file must contain at least one of the sections - `[paths]`, `[libs]`, `[packages]`
 ## How to install it

{robotframework_libtoc-1.4.0 → robotframework_libtoc-1.4.2}/README.md

@@ -5,7 +5,7 @@ This tool generates docs using Robot Framework [Libdoc](https://robotframework.o
 
 ## Why use it
 The 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.
+If you have several keyword libraries or resources, 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.   
@@ -18,10 +18,13 @@ in the intranet or uploaded as CI artifact - so everybody can easily access the
 ## How it works
 - The tool goes through the specified folders with RF resources and it's **direct** subfolders
 - It looks for the **config files** named `.libtoc` which contain items you would like to create docs for:
-    1. Paths to resource files in [glob format](https://en.wikipedia.org/wiki/Glob_(programming))
-    2. Paths to resources files in [glob format](https://en.wikipedia.org/wiki/Glob_(programming)) inside packages loaded from the pythonpath
-    3. Installed RF libraries - names and necessary import params like described in [libdoc user guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#general-usage)
+    1. Paths to resource/lib files in [glob format](https://en.wikipedia.org/wiki/Glob_(programming))
+    2. RF libraries, installed or available in PYTHONPATH using the provided fully qualified name
+        > Librariy import params (if necessary) like described in [libdoc user guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#general-usage)
         > Other libdoc CLI options (e.g. version or name of the output file) are not supported
+    3. Paths to resource/lib files in [glob format](https://en.wikipedia.org/wiki/Glob_(programming)) inside Python packages, loaded from the PYTHONPATH
+        > See more about bundling RF resources in Python packages in [RF User Guide](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#taking-resource-files-into-use)
+    
 - Then it generates the docs using `libdoc` - both for files paths, resolved from the glob patterns, and for the installed libraries. The created HTML files are placed in the **libtoc output_dir** - keeping the original subfolder structure of resources
 - Finally it generates a **TOC (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.
@@ -29,19 +32,23 @@ in the intranet or uploaded as CI artifact - so everybody can easily access the
 ```
 [paths]
 # Use glob patterns
-**/*.robot
-**/*.resource
-**/*.py
-
-[packages]
-example_package:resources/**/*.resource
+some-resources/**/*.robot
+some-resources/**/*.resource
+some-resources/**/*.py
 
 [libs]
 # Use RF library names with params - like for libdoc
 SeleniumLibrary
 Remote::http://10.0.0.42:8270
+# Import a library from PYTHONPATH using fully qualified name
+some-libs.mylib.mypy
 # You can use environment variables in lib params
 SomeLib::$some_env_var/somepath
+
+[packages]
+# Use package name in python path and glob patterns separated by :
+some-package:resources/**/*.resource
+some-package:libs/**/*.py
 ```
 > The config file must contain at least one of the sections - `[paths]`, `[libs]`, `[packages]`
 ## How to install it

{robotframework_libtoc-1.4.0 → robotframework_libtoc-1.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "robotframework-libtoc"
-version = "1.4.0"
+version = "1.4.2"
 description = "Docs and TOC generator for Robot Framework resources and libs"
 authors = ["Andre Mochinin"]
 license = "Apache-2.0"

{robotframework_libtoc-1.4.0 → robotframework_libtoc-1.4.2}/robotframework_libtoc/toc_template.html

@@ -1,5 +1,6 @@
 <html>
     <head>
+        <meta charset="utf-8">
     <style>
     body { font-family: "Lato", sans-serif;}
     .collapsible { background: none; color: #818181; cursor: pointer; padding: 6px 6px 6px 32px; width: 100%; text-align: