rolfedh-doc-utils 0.1.7__py3-none-any.whl → 0.1.8__py3-none-any.whl

{rolfedh_doc_utils-0.1.7.dist-info → rolfedh_doc_utils-0.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rolfedh-doc-utils
-Version: 0.1.7
+Version: 0.1.8
 Summary: CLI tools for AsciiDoc documentation projects
 Author: Rolfe Dlugy-Hegwer
 License: MIT License
@@ -54,7 +54,11 @@ These tools can modify or delete files. **Always:**
 ### Install with pipx (Recommended)
 
 ```bash
+# Install
 pipx install rolfedh-doc-utils
+
+# Upgrade to latest version
+pipx upgrade rolfedh-doc-utils
 ```
 
 ### Alternative Installation
@@ -71,18 +75,36 @@ pip install -e .
 
 ## 🛠️ Available Tools
 
+**Note:** Commands use hyphens (`-`), while Python files use underscores (`_`). After installing with pipx, use the hyphenated commands directly.
+
 | Tool | Description | Usage |
 |------|-------------|-------|
-| **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run .` |
+| **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
 | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
-| **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files --archive` |
-| **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images --archive` |
+| **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |
+| **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images` (preview)<br>`archive-unused-images --archive` (execute) |
 | **`find-unused-attributes`** | Identifies unused attribute definitions | `find-unused-attributes attributes.adoc` |
 
 ## 📖 Documentation
 
 Comprehensive documentation is available at **[rolfedh.github.io/doc-utils](https://rolfedh.github.io/doc-utils/)**
 
+### OpenShift-docs Example
+
+For OpenShift documentation repositories:
+
+```bash
+# Format spacing in specific directories
+format-asciidoc-spacing modules/
+format-asciidoc-spacing microshift_networking/
+
+# Preview changes first
+format-asciidoc-spacing --dry-run modules/networking/
+
+# Process specific file
+format-asciidoc-spacing modules/networking/about-networking.adoc
+```
+
 - [Getting Started Guide](https://rolfedh.github.io/doc-utils/getting-started)
 - [Tools Reference](https://rolfedh.github.io/doc-utils/tools/)
 - [Best Practices](https://rolfedh.github.io/doc-utils/best-practices)

{rolfedh_doc_utils-0.1.7.dist-info → rolfedh_doc_utils-0.1.8.dist-info}/RECORD

@@ -10,9 +10,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.7.dist-info/licenses/LICENSE,sha256=vLxtwMVOJA_hEy8b77niTkdmQI9kNJskXHq0dBS36e0,1075
-rolfedh_doc_utils-0.1.7.dist-info/METADATA,sha256=KZ9pa1ZFWS_rj4iVRW9TTbL6RPWvVFfL2twZseuk9Ko,6200
-rolfedh_doc_utils-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rolfedh_doc_utils-0.1.7.dist-info/entry_points.txt,sha256=dA-u4qlxKcewUAOFgaeW1NUIrkhsVknuwFuGTn1-84w,271
-rolfedh_doc_utils-0.1.7.dist-info/top_level.txt,sha256=WrYqTa4wbjRPMUl2hgJBfP734XsXLkhbnzUublx8S0s,119
-rolfedh_doc_utils-0.1.7.dist-info/RECORD,,
+rolfedh_doc_utils-0.1.8.dist-info/licenses/LICENSE,sha256=vLxtwMVOJA_hEy8b77niTkdmQI9kNJskXHq0dBS36e0,1075
+rolfedh_doc_utils-0.1.8.dist-info/METADATA,sha256=KrjqTRhF_B26ZNt37SZXReMcV4-ztpy1aWHJepYxMDE,6891
+rolfedh_doc_utils-0.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rolfedh_doc_utils-0.1.8.dist-info/entry_points.txt,sha256=dA-u4qlxKcewUAOFgaeW1NUIrkhsVknuwFuGTn1-84w,271
+rolfedh_doc_utils-0.1.8.dist-info/top_level.txt,sha256=WrYqTa4wbjRPMUl2hgJBfP734XsXLkhbnzUublx8S0s,119
+rolfedh_doc_utils-0.1.8.dist-info/RECORD,,