rolfedh-doc-utils 0.1.7__tar.gz → 0.1.8__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/PKG-INFO +26 -4
  2. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/README.md +25 -3
  3. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/pyproject.toml +1 -1
  4. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/rolfedh_doc_utils.egg-info/PKG-INFO +26 -4
  5. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/LICENSE +0 -0
  6. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/archive_unused_files.py +0 -0
  7. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/archive_unused_images.py +0 -0
  8. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/check_scannability.py +0 -0
  9. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/doc_utils/__init__.py +0 -0
  10. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/doc_utils/file_utils.py +0 -0
  11. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/doc_utils/scannability.py +0 -0
  12. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/doc_utils/topic_map_parser.py +0 -0
  13. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/doc_utils/unused_adoc.py +0 -0
  14. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/doc_utils/unused_attributes.py +0 -0
  15. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/doc_utils/unused_images.py +0 -0
  16. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/find_unused_attributes.py +0 -0
  17. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/format_asciidoc_spacing.py +0 -0
  18. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/rolfedh_doc_utils.egg-info/SOURCES.txt +0 -0
  19. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/rolfedh_doc_utils.egg-info/dependency_links.txt +0 -0
  20. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/rolfedh_doc_utils.egg-info/entry_points.txt +0 -0
  21. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/rolfedh_doc_utils.egg-info/requires.txt +0 -0
  22. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/rolfedh_doc_utils.egg-info/top_level.txt +0 -0
  23. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/setup.cfg +0 -0
  24. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/setup.py +0 -0
  25. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_archive_unused_files.py +0 -0
  26. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_archive_unused_images.py +0 -0
  27. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_auto_discovery.py +0 -0
  28. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_check_scannability.py +0 -0
  29. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_cli_entry_points.py +0 -0
  30. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_file_utils.py +0 -0
  31. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_fixture_archive_unused_files.py +0 -0
  32. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_fixture_archive_unused_images.py +0 -0
  33. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_fixture_check_scannability.py +0 -0
  34. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_parse_exclude_list.py +0 -0
  35. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_symlink_handling.py +0 -0
  36. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_topic_map_parser.py +0 -0
  37. {rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/tests/test_unused_attributes.py +0 -0
{rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: rolfedh-doc-utils
3
- Version: 0.1.7
3
+ Version: 0.1.8
4
4
  Summary: CLI tools for AsciiDoc documentation projects
5
5
  Author: Rolfe Dlugy-Hegwer
6
6
  License: MIT License
@@ -54,7 +54,11 @@ These tools can modify or delete files. **Always:**
54
54
  ### Install with pipx (Recommended)
55
55
 
56
56
  ```bash
57
+ # Install
57
58
  pipx install rolfedh-doc-utils
59
+
60
+ # Upgrade to latest version
61
+ pipx upgrade rolfedh-doc-utils
58
62
  ```
59
63
 
60
64
  ### Alternative Installation
@@ -71,18 +75,36 @@ pip install -e .
71
75
 
72
76
  ## 🛠️ Available Tools
73
77
 
78
+ **Note:** Commands use hyphens (`-`), while Python files use underscores (`_`). After installing with pipx, use the hyphenated commands directly.
79
+
74
80
  | Tool | Description | Usage |
75
81
  |------|-------------|-------|
76
- | **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run .` |
82
+ | **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
77
83
  | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
78
- | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files --archive` |
79
- | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images --archive` |
84
+ | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |
85
+ | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images` (preview)<br>`archive-unused-images --archive` (execute) |
80
86
  | **`find-unused-attributes`** | Identifies unused attribute definitions | `find-unused-attributes attributes.adoc` |
81
87
 
82
88
  ## 📖 Documentation
83
89
 
84
90
  Comprehensive documentation is available at **[rolfedh.github.io/doc-utils](https://rolfedh.github.io/doc-utils/)**
85
91
 
92
+ ### OpenShift-docs Example
93
+
94
+ For OpenShift documentation repositories:
95
+
96
+ ```bash
97
+ # Format spacing in specific directories
98
+ format-asciidoc-spacing modules/
99
+ format-asciidoc-spacing microshift_networking/
100
+
101
+ # Preview changes first
102
+ format-asciidoc-spacing --dry-run modules/networking/
103
+
104
+ # Process specific file
105
+ format-asciidoc-spacing modules/networking/about-networking.adoc
106
+ ```
107
+
86
108
  - [Getting Started Guide](https://rolfedh.github.io/doc-utils/getting-started)
87
109
  - [Tools Reference](https://rolfedh.github.io/doc-utils/tools/)
88
110
  - [Best Practices](https://rolfedh.github.io/doc-utils/best-practices)
{rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/README.md RENAMED
@@ -21,7 +21,11 @@ These tools can modify or delete files. **Always:**
21
21
  ### Install with pipx (Recommended)
22
22
 
23
23
  ```bash
24
+ # Install
24
25
  pipx install rolfedh-doc-utils
26
+
27
+ # Upgrade to latest version
28
+ pipx upgrade rolfedh-doc-utils
25
29
  ```
26
30
 
27
31
  ### Alternative Installation
@@ -38,18 +42,36 @@ pip install -e .
38
42
 
39
43
  ## 🛠️ Available Tools
40
44
 
45
+ **Note:** Commands use hyphens (`-`), while Python files use underscores (`_`). After installing with pipx, use the hyphenated commands directly.
46
+
41
47
  | Tool | Description | Usage |
42
48
  |------|-------------|-------|
43
- | **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run .` |
49
+ | **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
44
50
  | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
45
- | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files --archive` |
46
- | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images --archive` |
51
+ | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |
52
+ | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images` (preview)<br>`archive-unused-images --archive` (execute) |
47
53
  | **`find-unused-attributes`** | Identifies unused attribute definitions | `find-unused-attributes attributes.adoc` |
48
54
 
49
55
  ## 📖 Documentation
50
56
 
51
57
  Comprehensive documentation is available at **[rolfedh.github.io/doc-utils](https://rolfedh.github.io/doc-utils/)**
52
58
 
59
+ ### OpenShift-docs Example
60
+
61
+ For OpenShift documentation repositories:
62
+
63
+ ```bash
64
+ # Format spacing in specific directories
65
+ format-asciidoc-spacing modules/
66
+ format-asciidoc-spacing microshift_networking/
67
+
68
+ # Preview changes first
69
+ format-asciidoc-spacing --dry-run modules/networking/
70
+
71
+ # Process specific file
72
+ format-asciidoc-spacing modules/networking/about-networking.adoc
73
+ ```
74
+
53
75
  - [Getting Started Guide](https://rolfedh.github.io/doc-utils/getting-started)
54
76
  - [Tools Reference](https://rolfedh.github.io/doc-utils/tools/)
55
77
  - [Best Practices](https://rolfedh.github.io/doc-utils/best-practices)
{rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/pyproject.toml RENAMED
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "rolfedh-doc-utils"
7
- version = "0.1.7"
7
+ version = "0.1.8"
8
8
  description = "CLI tools for AsciiDoc documentation projects"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.8"
{rolfedh_doc_utils-0.1.7 → rolfedh_doc_utils-0.1.8}/rolfedh_doc_utils.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: rolfedh-doc-utils
3
- Version: 0.1.7
3
+ Version: 0.1.8
4
4
  Summary: CLI tools for AsciiDoc documentation projects
5
5
  Author: Rolfe Dlugy-Hegwer
6
6
  License: MIT License
@@ -54,7 +54,11 @@ These tools can modify or delete files. **Always:**
54
54
  ### Install with pipx (Recommended)
55
55
 
56
56
  ```bash
57
+ # Install
57
58
  pipx install rolfedh-doc-utils
59
+
60
+ # Upgrade to latest version
61
+ pipx upgrade rolfedh-doc-utils
58
62
  ```
59
63
 
60
64
  ### Alternative Installation
@@ -71,18 +75,36 @@ pip install -e .
71
75
 
72
76
  ## 🛠️ Available Tools
73
77
 
78
+ **Note:** Commands use hyphens (`-`), while Python files use underscores (`_`). After installing with pipx, use the hyphenated commands directly.
79
+
74
80
  | Tool | Description | Usage |
75
81
  |------|-------------|-------|
76
- | **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run .` |
82
+ | **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
77
83
  | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
78
- | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files --archive` |
79
- | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images --archive` |
84
+ | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |
85
+ | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images` (preview)<br>`archive-unused-images --archive` (execute) |
80
86
  | **`find-unused-attributes`** | Identifies unused attribute definitions | `find-unused-attributes attributes.adoc` |
81
87
 
82
88
  ## 📖 Documentation
83
89
 
84
90
  Comprehensive documentation is available at **[rolfedh.github.io/doc-utils](https://rolfedh.github.io/doc-utils/)**
85
91
 
92
+ ### OpenShift-docs Example
93
+
94
+ For OpenShift documentation repositories:
95
+
96
+ ```bash
97
+ # Format spacing in specific directories
98
+ format-asciidoc-spacing modules/
99
+ format-asciidoc-spacing microshift_networking/
100
+
101
+ # Preview changes first
102
+ format-asciidoc-spacing --dry-run modules/networking/
103
+
104
+ # Process specific file
105
+ format-asciidoc-spacing modules/networking/about-networking.adoc
106
+ ```
107
+
86
108
  - [Getting Started Guide](https://rolfedh.github.io/doc-utils/getting-started)
87
109
  - [Tools Reference](https://rolfedh.github.io/doc-utils/tools/)
88
110
  - [Best Practices](https://rolfedh.github.io/doc-utils/best-practices)