robotframework-libtoc 1.5.0__tar.gz → 1.6.0__tar.gz

{robotframework_libtoc-1.5.0 → robotframework_libtoc-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-libtoc
-Version: 1.5.0
+Version: 1.6.0
 Summary: Docs and TOC generator for Robot Framework resources and libs
 Home-page: https://github.com/amochin/robotframework-libtoc
 License: Apache-2.0
@@ -21,7 +21,7 @@ Description-Content-Type: text/markdown
 ## Robot Framework LibTOC
 
 ## What it does
-This tool generates docs using Robot Framework [Libdoc](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#libdoc) for an entire folder (or multiple folders) with Robot Framework resources/libs and creates a TOC (table of contents) file for them
+This tool generates docs using Robot Framework [Libdoc](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#libdoc) for an entire folder (or multiple folders) with Robot Framework resources/libs and creates a TOC (table of contents) file for them.
 
 ## Why use it
 The Robot Framework Libdoc tool normally generates a HTML file for a single keyword library or a resource file.
@@ -84,11 +84,12 @@ pip install robotframework-libtoc
 - Create the `.libtoc` config files in the *root of the resources folder* and/or in *direct subfolders* where you need docs to be created.    
 - Run `libtoc`. The last `resources_dirs` parameter is mandatory, it takes any number of paths. Other params are optional:
     - `-d, --output_dir`
+    - `-P, --pythonpath`
     - `--config_file`
     - `--toc_file`
     - `--toc_template`
     - `--homepage_template`
-    - `-P, --pythonpath`
+    - `--no_timestamp`
 
     Examples:
     ```shell
@@ -111,4 +112,3 @@ There are two ways to extend the list of paths where the libraries are searched
 2. Set the **PYTHONPATH** environment variable
 
 See more in [Robot Framework User Guide](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#pythonpath).
-

{robotframework_libtoc-1.5.0 → robotframework_libtoc-1.6.0}/README.md

@@ -1,7 +1,7 @@
 ## Robot Framework LibTOC
 
 ## What it does
-This tool generates docs using Robot Framework [Libdoc](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#libdoc) for an entire folder (or multiple folders) with Robot Framework resources/libs and creates a TOC (table of contents) file for them
+This tool generates docs using Robot Framework [Libdoc](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#libdoc) for an entire folder (or multiple folders) with Robot Framework resources/libs and creates a TOC (table of contents) file for them.
 
 ## Why use it
 The Robot Framework Libdoc tool normally generates a HTML file for a single keyword library or a resource file.
@@ -64,11 +64,12 @@ pip install robotframework-libtoc
 - Create the `.libtoc` config files in the *root of the resources folder* and/or in *direct subfolders* where you need docs to be created.    
 - Run `libtoc`. The last `resources_dirs` parameter is mandatory, it takes any number of paths. Other params are optional:
     - `-d, --output_dir`
+    - `-P, --pythonpath`
     - `--config_file`
     - `--toc_file`
     - `--toc_template`
     - `--homepage_template`
-    - `-P, --pythonpath`
+    - `--no_timestamp`
 
     Examples:
     ```shell
@@ -90,4 +91,4 @@ There are two ways to extend the list of paths where the libraries are searched
 1. Using the `--pythonpath` option
 2. Set the **PYTHONPATH** environment variable
 
-See more in [Robot Framework User Guide](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#pythonpath).
+See more in [Robot Framework User Guide](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#pythonpath).

{robotframework_libtoc-1.5.0 → robotframework_libtoc-1.6.0}/pyproject.toml

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

{robotframework_libtoc-1.5.0 → robotframework_libtoc-1.6.0}/robotframework_libtoc/libtoc.py

@@ -29,7 +29,10 @@ def toc(links, timestamp, home_page_path, template_file="", search_index=None):
 
     result = html_template.replace("{}", home_page_path, 1)
     result = result.replace("{}", links, 1)
-    result = result.replace("{}", timestamp, 1)
+    if timestamp:
+        result = result.replace("{}", timestamp, 1)
+    else:
+        result = result.replace("Created: {}", "", 1)
 
     # inject search index data (done after format() to avoid brace escaping issues)
     if search_index is not None:
@@ -121,16 +124,16 @@ def extract_libdoc_data(html_file_path):
     return None
 
 
-def build_search_index(src_dir, base_dir):
+def build_search_index(src_dir, base_dir, homepage_file):
     """
-    Builds a search index from all libdoc HTML files in src_dir.
+    Builds a search index from all libdoc HTML files in src_dir (except ``homepage_file``).
     Returns a list of library/resource entries with their keywords.
     """
     index = []
     for dirpath, dirnames, filenames in os.walk(src_dir):
         dirnames.sort()
         for file_name in sorted(filenames):
-            if file_name.endswith(".html") and file_name != "homepage.html":
+            if file_name.endswith(".html") and file_name != homepage_file:
                 file_path = os.path.join(dirpath, file_name)
                 data = extract_libdoc_data(file_path)
                 if data:
@@ -170,9 +173,31 @@ def build_search_index(src_dir, base_dir):
     return index
 
 
-def inject_libtoc_script(src_dir):
+def strip_libdoc_timestamps(src_dir, homepage_file):
+    """
+    Removes the 'generated' timestamp from the libdoc JSON data embedded in each
+    libdoc HTML file in src_dir (except ``homepage_file``), replacing it with an empty string.
+    """
+    for dirpath, dirnames, filenames in os.walk(src_dir):
+        dirnames.sort()
+        for file_name in sorted(filenames):
+            if file_name.endswith(".html") and file_name != homepage_file:
+                file_path = os.path.join(dirpath, file_name)
+                with open(file_path, "r", encoding="utf-8") as f:
+                    content = f.read()
+                new_content = re.sub(
+                    r'"generated":\s*"[^"]*"',
+                    '"generated": ""',
+                    content,
+                )
+                if new_content != content:
+                    with open(file_path, "w", encoding="utf-8") as f:
+                        f.write(new_content)
+
+
+def inject_libtoc_script(src_dir, homepage_file):
     """
-    Injects a small <script> into each libdoc HTML file in src_dir that:
+    Injects a small <script> into each libdoc HTML file in src_dir (except ``homepage_file``) that:
     - Reads the theme from localStorage and applies data-theme on <html> so the
       page respects the libtoc theme choice even when file:// cross-origin prevents
       parent frame DOM access.
@@ -201,7 +226,7 @@ def inject_libtoc_script(src_dir):
     for dirpath, dirnames, filenames in os.walk(src_dir):
         dirnames.sort()
         for file_name in sorted(filenames):
-            if file_name.endswith(".html") and file_name != "homepage.html":
+            if file_name.endswith(".html") and file_name != homepage_file:
                 file_path = os.path.join(dirpath, file_name)
                 with open(file_path, "r", encoding="utf-8") as f:
                     content = f.read()
@@ -353,6 +378,7 @@ def create_toc(
     homepage_file="homepage.html",
     toc_template="",
     homepage_template="",
+    no_timestamp=False,
 ):
     """
     Generates a `toc_file` (Table of Contents) HTML page with links to all HTML files inside the `html_docs_dir` and all it's subfolders.
@@ -376,16 +402,20 @@ def create_toc(
 
     # create homepage in "src"
     homepage_path = os.path.join(src_subdir, homepage_file)
-    current_date_time = datetime.now().strftime("%d.%m.%Y %H:%M:%S")
+    current_date_time = "" if no_timestamp else datetime.now().strftime("%d.%m.%Y %H:%M:%S")
     doc_files_links = add_files_from_folder(src_subdir, os.path.abspath(html_docs_dir))
     with open(homepage_path, "w", encoding="utf8") as f:
         f.write(homepage(homepage_template))
 
     # build search index from generated docs
-    search_index = build_search_index(src_subdir, os.path.abspath(html_docs_dir))
+    search_index = build_search_index(src_subdir, os.path.abspath(html_docs_dir), homepage_file)
+
+    # strip timestamps from libdoc HTML files if requested
+    if no_timestamp:
+        strip_libdoc_timestamps(src_subdir, homepage_file)
 
     # inject libtoc script into all libdoc HTML files
-    inject_libtoc_script(src_subdir)
+    inject_libtoc_script(src_subdir, homepage_file)
 
     # create TOC
     toc_file_path = os.path.join(html_docs_dir, toc_file)
@@ -430,6 +460,12 @@ def main():
         default="",
         help="Custom HTML template for the homepage file",
     )
+    parser.add_argument(
+        "--no_timestamp",
+        action="store_true",
+        default=False,
+        help="Do not include timestamps in the generated TOC and libdoc HTML files",
+    )
     parser.add_argument(
         "-P",
         "--pythonpath",
@@ -513,6 +549,7 @@ def main():
             args.toc_file,
             toc_template=args.toc_template,
             homepage_template=args.homepage_template,
+            no_timestamp=args.no_timestamp,
         )
     else:
         print("No docs were created!")