rolfedh-doc-utils 0.1.5__py3-none-any.whl → 0.1.6__py3-none-any.whl

{rolfedh_doc_utils-0.1.5.dist-info → rolfedh_doc_utils-0.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rolfedh-doc-utils
-Version: 0.1.5
+Version: 0.1.6
 Summary: CLI tools for AsciiDoc documentation projects
 Author: Rolfe Dlugy-Hegwer
 License: MIT License
@@ -99,6 +99,7 @@ The following CLI tools are installed:
 * `archive-unused-files`
 * `archive-unused-images`
 * `find-unused-attributes`
+* `format-asciidoc-spacing`
 
 These tools can be run from any directory.
 
@@ -132,7 +133,7 @@ Scans `.adoc` files in the current directory to report:
 * Paragraphs with too many sentences (default: 3 sentences)
 * Supports exclusion of files and directories
 
-➡️ See [`check_scannability.md`](https://github.com/rolfedh/doc-utils/blob/main/check_scannability.md) for details.
+➡️ See [Scannability Checker for AsciiDoc Files](https://github.com/rolfedh/doc-utils/blob/main/check_scannability.md) for details.
 
 ---
 
@@ -144,7 +145,7 @@ Works with both:
 - **OpenShift-docs style** repositories (uses `_topic_maps/*.yml` files)
 - **Traditional AsciiDoc** repositories (uses `master.adoc` files)
 
-➡️ See [`archive_unused_files.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_files.md).
+➡️ See [Archive Unused AsciiDoc Files](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_files.md).
 
 ---
 
@@ -152,7 +153,7 @@ Works with both:
 
 Finds unused image files (e.g., `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`) in the current directory and optionally archives and deletes them.
 
-➡️ See [`archive_unused_images.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_images.md).
+➡️ See [Archive Unused Images](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_images.md).
 
 ---
 
@@ -160,7 +161,22 @@ Finds unused image files (e.g., `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`) in the
 
 Scans an attributes file (e.g., `attributes.adoc`) for unused attribute definitions across all `.adoc` files in the current directory.
 
-➡️ See [`find_unused_attributes.md`](https://github.com/rolfedh/doc-utils/blob/main/find_unused_attributes.md).
+➡️ See [Find Unused AsciiDoc Attributes](https://github.com/rolfedh/doc-utils/blob/main/find_unused_attributes.md).
+
+---
+
+### `format-asciidoc-spacing`
+
+Ensures proper spacing in AsciiDoc files by adding blank lines after headings and around `include::` directives.
+
+Formatting rules:
+- Adds blank line after headings (`=`, `==`, `===`, etc.)
+- Adds blank lines before and after `include::` directives
+- Preserves existing spacing where appropriate
+
+Implemented as a Python script (`format-asciidoc-spacing.py`).
+
+➡️ See [AsciiDoc Spacing Formatter](https://github.com/rolfedh/doc-utils/blob/main/format_asciidoc_spacing.md).
 
 ## Best Practices for Safe Usage
 
@@ -191,6 +207,7 @@ To run the tools after installation:
 check-scannability --help
 archive-unused-files --help
 find-unused-attributes attributes.adoc
+format-asciidoc-spacing --help
 ```
 
 Or run them directly from source:
@@ -199,6 +216,7 @@ Or run them directly from source:
 python3 check_scannability.py
 python3 archive_unused_files.py
 python3 find_unused_attributes.py attributes.adoc
+python3 format-asciidoc-spacing.py
 ```
 
 ### Directory/File Exclusion
@@ -278,7 +296,7 @@ Contributions are welcome! Please ensure:
 - Code follows PEP 8 style guidelines
 - Documentation is updated as needed
 
-See [CONTRIBUTING.md](https://github.com/rolfedh/doc-utils/blob/main/CONTRIBUTING.md) for more details.
+See [Contributing Guidelines](https://github.com/rolfedh/doc-utils/blob/main/CONTRIBUTING.md) for more details.
 
 ## License
 

{rolfedh_doc_utils-0.1.5.dist-info → rolfedh_doc_utils-0.1.6.dist-info}/RECORD

@@ -9,9 +9,9 @@ doc_utils/topic_map_parser.py,sha256=tKcIO1m9r2K6dvPRGue58zqMr0O2zKU1gnZMzEE3U6o
 doc_utils/unused_adoc.py,sha256=2cbqcYr1os2EhETUU928BlPRlsZVSdI00qaMhqjSIqQ,5263
 doc_utils/unused_attributes.py,sha256=HBgmHelqearfWl3TTC2bZGiJytjLADIgiGQUNKqXXPg,1847
 doc_utils/unused_images.py,sha256=nqn36Bbrmon2KlGlcaruNjJJvTQ8_9H0WU9GvCW7rW8,1456
-rolfedh_doc_utils-0.1.5.dist-info/licenses/LICENSE,sha256=vLxtwMVOJA_hEy8b77niTkdmQI9kNJskXHq0dBS36e0,1075
-rolfedh_doc_utils-0.1.5.dist-info/METADATA,sha256=pSqhon_Hxstw72EnvJ-4UusaepxhdOvxUI0OqTF0toQ,8152
-rolfedh_doc_utils-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rolfedh_doc_utils-0.1.5.dist-info/entry_points.txt,sha256=i8LqEsp0KD4YyVI_7wQ1TMgCuag32D7gQes6bLufmtM,216
-rolfedh_doc_utils-0.1.5.dist-info/top_level.txt,sha256=BkaYN3KbtNvLQjs-QGBKCJb5UAtjEbC_IqxSSIN9P-w,95
-rolfedh_doc_utils-0.1.5.dist-info/RECORD,,
+rolfedh_doc_utils-0.1.6.dist-info/licenses/LICENSE,sha256=vLxtwMVOJA_hEy8b77niTkdmQI9kNJskXHq0dBS36e0,1075
+rolfedh_doc_utils-0.1.6.dist-info/METADATA,sha256=JoFOMLPMcQiGaSXBwqXLVZP5jLahLSP0s8_go98X4N8,8787
+rolfedh_doc_utils-0.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rolfedh_doc_utils-0.1.6.dist-info/entry_points.txt,sha256=dA-u4qlxKcewUAOFgaeW1NUIrkhsVknuwFuGTn1-84w,271
+rolfedh_doc_utils-0.1.6.dist-info/top_level.txt,sha256=WrYqTa4wbjRPMUl2hgJBfP734XsXLkhbnzUublx8S0s,119
+rolfedh_doc_utils-0.1.6.dist-info/RECORD,,

{rolfedh_doc_utils-0.1.5.dist-info → rolfedh_doc_utils-0.1.6.dist-info}/entry_points.txt

@@ -3,3 +3,4 @@ archive-unused-files = archive_unused_files:main
 archive-unused-images = archive_unused_images:main
 check-scannability = check_scannability:main
 find-unused-attributes = find_unused_attributes:main
+format-asciidoc-spacing = format_asciidoc_spacing:main

{rolfedh_doc_utils-0.1.5.dist-info → rolfedh_doc_utils-0.1.6.dist-info}/top_level.txt

@@ -3,3 +3,4 @@ archive_unused_images
 check_scannability
 doc_utils
 find_unused_attributes
+format_asciidoc_spacing