rolfedh-doc-utils 0.1.5__tar.gz → 0.1.6__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 (36) hide show
  1. {rolfedh_doc_utils-0.1.5/rolfedh_doc_utils.egg-info → rolfedh_doc_utils-0.1.6}/PKG-INFO +24 -6
  2. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/README.md +23 -5
  3. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/pyproject.toml +3 -2
  4. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6/rolfedh_doc_utils.egg-info}/PKG-INFO +24 -6
  5. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/rolfedh_doc_utils.egg-info/entry_points.txt +1 -0
  6. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/rolfedh_doc_utils.egg-info/top_level.txt +1 -0
  7. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/LICENSE +0 -0
  8. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/archive_unused_files.py +0 -0
  9. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/archive_unused_images.py +0 -0
  10. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/check_scannability.py +0 -0
  11. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/doc_utils/__init__.py +0 -0
  12. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/doc_utils/file_utils.py +0 -0
  13. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/doc_utils/scannability.py +0 -0
  14. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/doc_utils/topic_map_parser.py +0 -0
  15. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/doc_utils/unused_adoc.py +0 -0
  16. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/doc_utils/unused_attributes.py +0 -0
  17. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/doc_utils/unused_images.py +0 -0
  18. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/find_unused_attributes.py +0 -0
  19. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/rolfedh_doc_utils.egg-info/SOURCES.txt +0 -0
  20. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/rolfedh_doc_utils.egg-info/dependency_links.txt +0 -0
  21. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/rolfedh_doc_utils.egg-info/requires.txt +0 -0
  22. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/setup.cfg +0 -0
  23. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/setup.py +0 -0
  24. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_archive_unused_files.py +0 -0
  25. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_archive_unused_images.py +0 -0
  26. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_auto_discovery.py +0 -0
  27. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_check_scannability.py +0 -0
  28. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_cli_entry_points.py +0 -0
  29. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_file_utils.py +0 -0
  30. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_fixture_archive_unused_files.py +0 -0
  31. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_fixture_archive_unused_images.py +0 -0
  32. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_fixture_check_scannability.py +0 -0
  33. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_parse_exclude_list.py +0 -0
  34. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_symlink_handling.py +0 -0
  35. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_topic_map_parser.py +0 -0
  36. {rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/tests/test_unused_attributes.py +0 -0
{rolfedh_doc_utils-0.1.5/rolfedh_doc_utils.egg-info → rolfedh_doc_utils-0.1.6}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: rolfedh-doc-utils
3
- Version: 0.1.5
3
+ Version: 0.1.6
4
4
  Summary: CLI tools for AsciiDoc documentation projects
5
5
  Author: Rolfe Dlugy-Hegwer
6
6
  License: MIT License
@@ -99,6 +99,7 @@ The following CLI tools are installed:
99
99
  * `archive-unused-files`
100
100
  * `archive-unused-images`
101
101
  * `find-unused-attributes`
102
+ * `format-asciidoc-spacing`
102
103
 
103
104
  These tools can be run from any directory.
104
105
 
@@ -132,7 +133,7 @@ Scans `.adoc` files in the current directory to report:
132
133
  * Paragraphs with too many sentences (default: 3 sentences)
133
134
  * Supports exclusion of files and directories
134
135
 
135
- ➡️ See [`check_scannability.md`](https://github.com/rolfedh/doc-utils/blob/main/check_scannability.md) for details.
136
+ ➡️ See [Scannability Checker for AsciiDoc Files](https://github.com/rolfedh/doc-utils/blob/main/check_scannability.md) for details.
136
137
 
137
138
  ---
138
139
 
@@ -144,7 +145,7 @@ Works with both:
144
145
  - **OpenShift-docs style** repositories (uses `_topic_maps/*.yml` files)
145
146
  - **Traditional AsciiDoc** repositories (uses `master.adoc` files)
146
147
 
147
- ➡️ See [`archive_unused_files.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_files.md).
148
+ ➡️ See [Archive Unused AsciiDoc Files](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_files.md).
148
149
 
149
150
  ---
150
151
 
@@ -152,7 +153,7 @@ Works with both:
152
153
 
153
154
  Finds unused image files (e.g., `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`) in the current directory and optionally archives and deletes them.
154
155
 
155
- ➡️ See [`archive_unused_images.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_images.md).
156
+ ➡️ See [Archive Unused Images](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_images.md).
156
157
 
157
158
  ---
158
159
 
@@ -160,7 +161,22 @@ Finds unused image files (e.g., `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`) in the
160
161
 
161
162
  Scans an attributes file (e.g., `attributes.adoc`) for unused attribute definitions across all `.adoc` files in the current directory.
162
163
 
163
- ➡️ See [`find_unused_attributes.md`](https://github.com/rolfedh/doc-utils/blob/main/find_unused_attributes.md).
164
+ ➡️ See [Find Unused AsciiDoc Attributes](https://github.com/rolfedh/doc-utils/blob/main/find_unused_attributes.md).
165
+
166
+ ---
167
+
168
+ ### `format-asciidoc-spacing`
169
+
170
+ Ensures proper spacing in AsciiDoc files by adding blank lines after headings and around `include::` directives.
171
+
172
+ Formatting rules:
173
+ - Adds blank line after headings (`=`, `==`, `===`, etc.)
174
+ - Adds blank lines before and after `include::` directives
175
+ - Preserves existing spacing where appropriate
176
+
177
+ Implemented as a Python script (`format-asciidoc-spacing.py`).
178
+
179
+ ➡️ See [AsciiDoc Spacing Formatter](https://github.com/rolfedh/doc-utils/blob/main/format_asciidoc_spacing.md).
164
180
 
165
181
  ## Best Practices for Safe Usage
166
182
 
@@ -191,6 +207,7 @@ To run the tools after installation:
191
207
  check-scannability --help
192
208
  archive-unused-files --help
193
209
  find-unused-attributes attributes.adoc
210
+ format-asciidoc-spacing --help
194
211
  ```
195
212
 
196
213
  Or run them directly from source:
@@ -199,6 +216,7 @@ Or run them directly from source:
199
216
  python3 check_scannability.py
200
217
  python3 archive_unused_files.py
201
218
  python3 find_unused_attributes.py attributes.adoc
219
+ python3 format-asciidoc-spacing.py
202
220
  ```
203
221
 
204
222
  ### Directory/File Exclusion
@@ -278,7 +296,7 @@ Contributions are welcome! Please ensure:
278
296
  - Code follows PEP 8 style guidelines
279
297
  - Documentation is updated as needed
280
298
 
281
- See [CONTRIBUTING.md](https://github.com/rolfedh/doc-utils/blob/main/CONTRIBUTING.md) for more details.
299
+ See [Contributing Guidelines](https://github.com/rolfedh/doc-utils/blob/main/CONTRIBUTING.md) for more details.
282
300
 
283
301
  ## License
284
302
 
{rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/README.md RENAMED
@@ -66,6 +66,7 @@ The following CLI tools are installed:
66
66
  * `archive-unused-files`
67
67
  * `archive-unused-images`
68
68
  * `find-unused-attributes`
69
+ * `format-asciidoc-spacing`
69
70
 
70
71
  These tools can be run from any directory.
71
72
 
@@ -99,7 +100,7 @@ Scans `.adoc` files in the current directory to report:
99
100
  * Paragraphs with too many sentences (default: 3 sentences)
100
101
  * Supports exclusion of files and directories
101
102
 
102
- ➡️ See [`check_scannability.md`](https://github.com/rolfedh/doc-utils/blob/main/check_scannability.md) for details.
103
+ ➡️ See [Scannability Checker for AsciiDoc Files](https://github.com/rolfedh/doc-utils/blob/main/check_scannability.md) for details.
103
104
 
104
105
  ---
105
106
 
@@ -111,7 +112,7 @@ Works with both:
111
112
  - **OpenShift-docs style** repositories (uses `_topic_maps/*.yml` files)
112
113
  - **Traditional AsciiDoc** repositories (uses `master.adoc` files)
113
114
 
114
- ➡️ See [`archive_unused_files.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_files.md).
115
+ ➡️ See [Archive Unused AsciiDoc Files](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_files.md).
115
116
 
116
117
  ---
117
118
 
@@ -119,7 +120,7 @@ Works with both:
119
120
 
120
121
  Finds unused image files (e.g., `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`) in the current directory and optionally archives and deletes them.
121
122
 
122
- ➡️ See [`archive_unused_images.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_images.md).
123
+ ➡️ See [Archive Unused Images](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_images.md).
123
124
 
124
125
  ---
125
126
 
@@ -127,7 +128,22 @@ Finds unused image files (e.g., `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`) in the
127
128
 
128
129
  Scans an attributes file (e.g., `attributes.adoc`) for unused attribute definitions across all `.adoc` files in the current directory.
129
130
 
130
- ➡️ See [`find_unused_attributes.md`](https://github.com/rolfedh/doc-utils/blob/main/find_unused_attributes.md).
131
+ ➡️ See [Find Unused AsciiDoc Attributes](https://github.com/rolfedh/doc-utils/blob/main/find_unused_attributes.md).
132
+
133
+ ---
134
+
135
+ ### `format-asciidoc-spacing`
136
+
137
+ Ensures proper spacing in AsciiDoc files by adding blank lines after headings and around `include::` directives.
138
+
139
+ Formatting rules:
140
+ - Adds blank line after headings (`=`, `==`, `===`, etc.)
141
+ - Adds blank lines before and after `include::` directives
142
+ - Preserves existing spacing where appropriate
143
+
144
+ Implemented as a Python script (`format-asciidoc-spacing.py`).
145
+
146
+ ➡️ See [AsciiDoc Spacing Formatter](https://github.com/rolfedh/doc-utils/blob/main/format_asciidoc_spacing.md).
131
147
 
132
148
  ## Best Practices for Safe Usage
133
149
 
@@ -158,6 +174,7 @@ To run the tools after installation:
158
174
  check-scannability --help
159
175
  archive-unused-files --help
160
176
  find-unused-attributes attributes.adoc
177
+ format-asciidoc-spacing --help
161
178
  ```
162
179
 
163
180
  Or run them directly from source:
@@ -166,6 +183,7 @@ Or run them directly from source:
166
183
  python3 check_scannability.py
167
184
  python3 archive_unused_files.py
168
185
  python3 find_unused_attributes.py attributes.adoc
186
+ python3 format-asciidoc-spacing.py
169
187
  ```
170
188
 
171
189
  ### Directory/File Exclusion
@@ -245,7 +263,7 @@ Contributions are welcome! Please ensure:
245
263
  - Code follows PEP 8 style guidelines
246
264
  - Documentation is updated as needed
247
265
 
248
- See [CONTRIBUTING.md](https://github.com/rolfedh/doc-utils/blob/main/CONTRIBUTING.md) for more details.
266
+ See [Contributing Guidelines](https://github.com/rolfedh/doc-utils/blob/main/CONTRIBUTING.md) for more details.
249
267
 
250
268
  ## License
251
269
 
{rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/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.5"
7
+ version = "0.1.6"
8
8
  description = "CLI tools for AsciiDoc documentation projects"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.8"
@@ -19,10 +19,11 @@ check-scannability = "check_scannability:main"
19
19
  archive-unused-files = "archive_unused_files:main"
20
20
  archive-unused-images = "archive_unused_images:main"
21
21
  find-unused-attributes = "find_unused_attributes:main"
22
+ format-asciidoc-spacing = "format_asciidoc_spacing:main"
22
23
 
23
24
  [tool.setuptools.packages.find]
24
25
  where = ["."]
25
26
  include = ["doc_utils*"]
26
27
 
27
28
  [tool.setuptools]
28
- py-modules = ["find_unused_attributes", "check_scannability", "archive_unused_files", "archive_unused_images"]
29
+ py-modules = ["find_unused_attributes", "check_scannability", "archive_unused_files", "archive_unused_images", "format_asciidoc_spacing"]
{rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6/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.5
3
+ Version: 0.1.6
4
4
  Summary: CLI tools for AsciiDoc documentation projects
5
5
  Author: Rolfe Dlugy-Hegwer
6
6
  License: MIT License
@@ -99,6 +99,7 @@ The following CLI tools are installed:
99
99
  * `archive-unused-files`
100
100
  * `archive-unused-images`
101
101
  * `find-unused-attributes`
102
+ * `format-asciidoc-spacing`
102
103
 
103
104
  These tools can be run from any directory.
104
105
 
@@ -132,7 +133,7 @@ Scans `.adoc` files in the current directory to report:
132
133
  * Paragraphs with too many sentences (default: 3 sentences)
133
134
  * Supports exclusion of files and directories
134
135
 
135
- ➡️ See [`check_scannability.md`](https://github.com/rolfedh/doc-utils/blob/main/check_scannability.md) for details.
136
+ ➡️ See [Scannability Checker for AsciiDoc Files](https://github.com/rolfedh/doc-utils/blob/main/check_scannability.md) for details.
136
137
 
137
138
  ---
138
139
 
@@ -144,7 +145,7 @@ Works with both:
144
145
  - **OpenShift-docs style** repositories (uses `_topic_maps/*.yml` files)
145
146
  - **Traditional AsciiDoc** repositories (uses `master.adoc` files)
146
147
 
147
- ➡️ See [`archive_unused_files.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_files.md).
148
+ ➡️ See [Archive Unused AsciiDoc Files](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_files.md).
148
149
 
149
150
  ---
150
151
 
@@ -152,7 +153,7 @@ Works with both:
152
153
 
153
154
  Finds unused image files (e.g., `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`) in the current directory and optionally archives and deletes them.
154
155
 
155
- ➡️ See [`archive_unused_images.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_images.md).
156
+ ➡️ See [Archive Unused Images](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_images.md).
156
157
 
157
158
  ---
158
159
 
@@ -160,7 +161,22 @@ Finds unused image files (e.g., `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`) in the
160
161
 
161
162
  Scans an attributes file (e.g., `attributes.adoc`) for unused attribute definitions across all `.adoc` files in the current directory.
162
163
 
163
- ➡️ See [`find_unused_attributes.md`](https://github.com/rolfedh/doc-utils/blob/main/find_unused_attributes.md).
164
+ ➡️ See [Find Unused AsciiDoc Attributes](https://github.com/rolfedh/doc-utils/blob/main/find_unused_attributes.md).
165
+
166
+ ---
167
+
168
+ ### `format-asciidoc-spacing`
169
+
170
+ Ensures proper spacing in AsciiDoc files by adding blank lines after headings and around `include::` directives.
171
+
172
+ Formatting rules:
173
+ - Adds blank line after headings (`=`, `==`, `===`, etc.)
174
+ - Adds blank lines before and after `include::` directives
175
+ - Preserves existing spacing where appropriate
176
+
177
+ Implemented as a Python script (`format-asciidoc-spacing.py`).
178
+
179
+ ➡️ See [AsciiDoc Spacing Formatter](https://github.com/rolfedh/doc-utils/blob/main/format_asciidoc_spacing.md).
164
180
 
165
181
  ## Best Practices for Safe Usage
166
182
 
@@ -191,6 +207,7 @@ To run the tools after installation:
191
207
  check-scannability --help
192
208
  archive-unused-files --help
193
209
  find-unused-attributes attributes.adoc
210
+ format-asciidoc-spacing --help
194
211
  ```
195
212
 
196
213
  Or run them directly from source:
@@ -199,6 +216,7 @@ Or run them directly from source:
199
216
  python3 check_scannability.py
200
217
  python3 archive_unused_files.py
201
218
  python3 find_unused_attributes.py attributes.adoc
219
+ python3 format-asciidoc-spacing.py
202
220
  ```
203
221
 
204
222
  ### Directory/File Exclusion
@@ -278,7 +296,7 @@ Contributions are welcome! Please ensure:
278
296
  - Code follows PEP 8 style guidelines
279
297
  - Documentation is updated as needed
280
298
 
281
- See [CONTRIBUTING.md](https://github.com/rolfedh/doc-utils/blob/main/CONTRIBUTING.md) for more details.
299
+ See [Contributing Guidelines](https://github.com/rolfedh/doc-utils/blob/main/CONTRIBUTING.md) for more details.
282
300
 
283
301
  ## License
284
302
 
{rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/rolfedh_doc_utils.egg-info/entry_points.txt RENAMED
@@ -3,3 +3,4 @@ archive-unused-files = archive_unused_files:main
3
3
  archive-unused-images = archive_unused_images:main
4
4
  check-scannability = check_scannability:main
5
5
  find-unused-attributes = find_unused_attributes:main
6
+ format-asciidoc-spacing = format_asciidoc_spacing:main
{rolfedh_doc_utils-0.1.5 → rolfedh_doc_utils-0.1.6}/rolfedh_doc_utils.egg-info/top_level.txt RENAMED
@@ -3,3 +3,4 @@ archive_unused_images
3
3
  check_scannability
4
4
  doc_utils
5
5
  find_unused_attributes
6
+ format_asciidoc_spacing