rolfedh-doc-utils 0.1.20__tar.gz → 0.1.21__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 (52) hide show
  1. {rolfedh_doc_utils-0.1.20/rolfedh_doc_utils.egg-info → rolfedh_doc_utils-0.1.21}/PKG-INFO +3 -3
  2. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/README.md +2 -2
  3. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/format_asciidoc_spacing.py +7 -1
  4. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/version.py +1 -1
  5. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils_cli.py +2 -2
  6. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/pyproject.toml +1 -1
  7. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21/rolfedh_doc_utils.egg-info}/PKG-INFO +3 -3
  8. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/LICENSE +0 -0
  9. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/archive_unused_files.py +0 -0
  10. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/archive_unused_images.py +0 -0
  11. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/check_scannability.py +0 -0
  12. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/__init__.py +0 -0
  13. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/extract_link_attributes.py +0 -0
  14. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/file_utils.py +0 -0
  15. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/replace_link_attributes.py +0 -0
  16. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/scannability.py +0 -0
  17. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/spinner.py +0 -0
  18. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/topic_map_parser.py +0 -0
  19. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/unused_adoc.py +0 -0
  20. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/unused_attributes.py +0 -0
  21. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/unused_images.py +0 -0
  22. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/validate_links.py +0 -0
  23. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/version_check.py +0 -0
  24. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/extract_link_attributes.py +0 -0
  25. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/find_unused_attributes.py +0 -0
  26. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/format_asciidoc_spacing.py +0 -0
  27. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/replace_link_attributes.py +0 -0
  28. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/rolfedh_doc_utils.egg-info/SOURCES.txt +0 -0
  29. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/rolfedh_doc_utils.egg-info/dependency_links.txt +0 -0
  30. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/rolfedh_doc_utils.egg-info/entry_points.txt +0 -0
  31. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/rolfedh_doc_utils.egg-info/requires.txt +0 -0
  32. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/rolfedh_doc_utils.egg-info/top_level.txt +0 -0
  33. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/setup.cfg +0 -0
  34. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/setup.py +0 -0
  35. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_archive_unused_files.py +0 -0
  36. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_archive_unused_images.py +0 -0
  37. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_auto_discovery.py +0 -0
  38. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_check_scannability.py +0 -0
  39. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_cli_entry_points.py +0 -0
  40. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_extract_link_attributes.py +0 -0
  41. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_file_utils.py +0 -0
  42. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_fixture_archive_unused_files.py +0 -0
  43. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_fixture_archive_unused_images.py +0 -0
  44. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_fixture_check_scannability.py +0 -0
  45. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_parse_exclude_list.py +0 -0
  46. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_replace_link_attributes.py +0 -0
  47. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_symlink_handling.py +0 -0
  48. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_topic_map_parser.py +0 -0
  49. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_unused_attributes.py +0 -0
  50. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_validate_links.py +0 -0
  51. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/tests/test_version_check.py +0 -0
  52. {rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/validate_links.py +0 -0
{rolfedh_doc_utils-0.1.20/rolfedh_doc_utils.egg-info → rolfedh_doc_utils-0.1.21}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: rolfedh-doc-utils
3
- Version: 0.1.20
3
+ Version: 0.1.21
4
4
  Summary: CLI tools for AsciiDoc documentation projects
5
5
  Author: Rolfe Dlugy-Hegwer
6
6
  License: MIT License
@@ -94,10 +94,10 @@ doc-utils --version # Show version
94
94
 
95
95
  | Tool | Description | Usage |
96
96
  |------|-------------|-------|
97
- | **`validate-links`** [EXPERIMENTAL] | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
97
+ | **`validate-links`** | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
98
98
  | **`extract-link-attributes`** | Extracts link/xref macros with attributes into reusable definitions | `extract-link-attributes --dry-run` |
99
99
  | **`replace-link-attributes`** | Resolves Vale LinkAttribute issues by replacing attributes in link URLs | `replace-link-attributes --dry-run` |
100
- | **`format-asciidoc-spacing`** [EXPERIMENTAL] | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
100
+ | **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
101
101
  | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
102
102
  | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |
103
103
  | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images` (preview)<br>`archive-unused-images --archive` (execute) |
{rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/README.md RENAMED
@@ -61,10 +61,10 @@ doc-utils --version # Show version
61
61
 
62
62
  | Tool | Description | Usage |
63
63
  |------|-------------|-------|
64
- | **`validate-links`** [EXPERIMENTAL] | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
64
+ | **`validate-links`** | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
65
65
  | **`extract-link-attributes`** | Extracts link/xref macros with attributes into reusable definitions | `extract-link-attributes --dry-run` |
66
66
  | **`replace-link-attributes`** | Resolves Vale LinkAttribute issues by replacing attributes in link URLs | `replace-link-attributes --dry-run` |
67
- | **`format-asciidoc-spacing`** [EXPERIMENTAL] | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
67
+ | **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
68
68
  | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
69
69
  | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |
70
70
  | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images` (preview)<br>`archive-unused-images --archive` (execute) |
{rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/format_asciidoc_spacing.py RENAMED
@@ -175,8 +175,14 @@ def process_file(file_path: Path, dry_run: bool = False, verbose: bool = False)
175
175
 
176
176
  # Check if current line is an include directive
177
177
  elif re.match(r'^include::', current_line):
178
- # Skip special handling if we're inside a conditional block
178
+ # Handle includes inside conditional blocks
179
179
  if in_conditional:
180
+ # Add blank line between consecutive includes within conditional blocks
181
+ if prev_line and re.match(r'^include::', prev_line):
182
+ new_lines.append("")
183
+ changes_made = True
184
+ if verbose:
185
+ messages.append(" Added blank line between includes in conditional block")
180
186
  new_lines.append(current_line)
181
187
  else:
182
188
  # Check if this is an attribute include (contains "attribute" in the path)
{rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils/version.py RENAMED
@@ -1,7 +1,7 @@
1
1
  """Version information for doc-utils."""
2
2
 
3
3
  # This should match the version in pyproject.toml
4
- __version__ = "0.1.20"
4
+ __version__ = "0.1.21"
5
5
 
6
6
  def get_version():
7
7
  """Return the current version string."""
{rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/doc_utils_cli.py RENAMED
@@ -15,7 +15,7 @@ from doc_utils.version_check import check_version_on_startup
15
15
  TOOLS = [
16
16
  {
17
17
  'name': 'validate-links',
18
- 'description': 'Validates all links in documentation with URL transposition [EXPERIMENTAL]',
18
+ 'description': 'Validates all links in documentation with URL transposition',
19
19
  'example': 'validate-links --transpose "https://prod--https://preview"'
20
20
  },
21
21
  {
@@ -30,7 +30,7 @@ TOOLS = [
30
30
  },
31
31
  {
32
32
  'name': 'format-asciidoc-spacing',
33
- 'description': 'Standardizes spacing after headings and around includes [EXPERIMENTAL]',
33
+ 'description': 'Standardizes spacing after headings and around includes',
34
34
  'example': 'format-asciidoc-spacing --dry-run modules/'
35
35
  },
36
36
  {
{rolfedh_doc_utils-0.1.20 → rolfedh_doc_utils-0.1.21}/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.20"
7
+ version = "0.1.21"
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.20 → rolfedh_doc_utils-0.1.21/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.20
3
+ Version: 0.1.21
4
4
  Summary: CLI tools for AsciiDoc documentation projects
5
5
  Author: Rolfe Dlugy-Hegwer
6
6
  License: MIT License
@@ -94,10 +94,10 @@ doc-utils --version # Show version
94
94
 
95
95
  | Tool | Description | Usage |
96
96
  |------|-------------|-------|
97
- | **`validate-links`** [EXPERIMENTAL] | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
97
+ | **`validate-links`** | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
98
98
  | **`extract-link-attributes`** | Extracts link/xref macros with attributes into reusable definitions | `extract-link-attributes --dry-run` |
99
99
  | **`replace-link-attributes`** | Resolves Vale LinkAttribute issues by replacing attributes in link URLs | `replace-link-attributes --dry-run` |
100
- | **`format-asciidoc-spacing`** [EXPERIMENTAL] | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
100
+ | **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
101
101
  | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
102
102
  | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |
103
103
  | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images` (preview)<br>`archive-unused-images --archive` (execute) |