rolfedh-doc-utils 0.1.27__py3-none-any.whl → 0.1.29__py3-none-any.whl

callout_lib/converter_bullets.py

@@ -59,8 +59,8 @@ class BulletListConverter:
                     user_value = f'{user_value}>'
                 term = f'`{user_value}`'
             else:
-                # This is a code line - use it as-is in backticks
-                term = f'`{code_line}`'
+                # This is a code line - strip whitespace before wrapping in backticks
+                term = f'`{code_line.strip()}`'
 
             # Collect all explanations for this group
             all_explanation_lines = []

callout_lib/converter_deflist.py

@@ -54,8 +54,8 @@ class DefListConverter:
                     user_value = f'{user_value}>'
                 term = f'`{user_value}`'
             else:
-                # This is a code line - use it as-is in backticks
-                term = f'`{code_line}`'
+                # This is a code line - strip whitespace before wrapping in backticks
+                term = f'`{code_line.strip()}`'
 
             # Add blank line before each term
             lines.append('')

callout_lib/detector.py

@@ -45,6 +45,11 @@ class CalloutDetector:
     # Pattern for callout number in code block (can appear multiple times per line)
     CALLOUT_IN_CODE = re.compile(r'<(\d+)>')
 
+    # Pattern for callout with optional preceding comment syntax
+    # Matches common comment styles: //, #, --, ;, followed by optional whitespace and <number>
+    # The comment syntax must be preceded by whitespace to avoid matching code operators
+    CALLOUT_WITH_COMMENT = re.compile(r'\s*(?://|#|--|;)\s*<\d+>|\s*<\d+>')
+
     # Pattern for callout explanation line: <1> Explanation text
     CALLOUT_EXPLANATION = re.compile(r'^<(\d+)>\s+(.+)$')
 
@@ -130,8 +135,9 @@ class CalloutDetector:
             # Look for all callout numbers on this line
             callout_matches = list(self.CALLOUT_IN_CODE.finditer(line))
             if callout_matches:
-                # Remove all callouts from the line to get the actual code
-                line_without_callouts = self.CALLOUT_IN_CODE.sub('', line).strip()
+                # Remove callouts AND preceding comment syntax from the line
+                # Use CALLOUT_WITH_COMMENT to remove both comment syntax and callout
+                line_without_callouts = self.CALLOUT_WITH_COMMENT.sub('', line).rstrip()
 
                 # Find all angle-bracket enclosed values
                 user_values = self.USER_VALUE_PATTERN.findall(line_without_callouts)
@@ -216,11 +222,11 @@ class CalloutDetector:
 
             # Add value lines with context
             if value_lines:
-                # Format: "Refers to `value`. Description..."
+                # Format: "`value`:"
                 value_text = value_lines[0] if value_lines else ""
                 # If value is code-like (contains backticks or special chars), keep it formatted
                 if value_text:
-                    all_lines.append(f"Refers to {value_text}.")
+                    all_lines.append(f"{value_text}:")
 
                 # Add additional value lines if multi-line
                 for line in value_lines[1:]:
@@ -290,11 +296,14 @@ class CalloutDetector:
         return explanations, i - 1
 
     def remove_callouts_from_code(self, content: List[str]) -> List[str]:
-        """Remove callout numbers from code block content (handles multiple callouts per line)."""
+        """
+        Remove callout numbers and preceding comment syntax from code block content.
+        Handles multiple callouts per line and various comment styles (//,  #, --, ;).
+        """
         cleaned = []
         for line in content:
-            # Remove all callout numbers and trailing whitespace
-            cleaned.append(self.CALLOUT_IN_CODE.sub('', line).rstrip())
+            # Remove all callout numbers with their preceding comment syntax
+            cleaned.append(self.CALLOUT_WITH_COMMENT.sub('', line).rstrip())
         return cleaned
 
     def validate_callouts(self, callout_groups: List[CalloutGroup], explanations: Dict[int, Callout]) -> Tuple[bool, set, set]:

callout_lib/table_parser.py

@@ -200,6 +200,17 @@ class TableParser:
                                 content=[part],
                                 conditionals=[]
                             ))
+
+                    # Multi-cell line completes a row - finalize it
+                    if current_row_cells:
+                        rows.append(TableRow(
+                            cells=current_row_cells.copy(),
+                            conditionals_before=conditionals_before_row.copy(),
+                            conditionals_after=conditionals_after_row.copy()
+                        ))
+                        current_row_cells = []
+                        conditionals_before_row = []
+                        conditionals_after_row = []
                 else:
                     # Single cell on this line
                     if cell_content:

doc_utils/format_asciidoc_spacing.py

@@ -65,9 +65,16 @@ def process_file(file_path: Path, dry_run: bool = False, verbose: bool = False)
             new_lines.append(current_line)
             in_conditional = False
             # Add blank line after conditional if needed
+            # Don't add if next line is:
+            # - a list item (starts with *, -, ., .., or numbered)
+            # - list continuation (+)
+            # - another conditional
+            # - blank
             if (next_line and
                 not re.match(r'^\s*$', next_line) and
-                not re.match(r'^(ifdef::|ifndef::|endif::)', next_line)):
+                not re.match(r'^(ifdef::|ifndef::|endif::)', next_line) and
+                not re.match(r'^(\*|\-|\.|\.\.|\d+\.)\s', next_line) and  # List items
+                not re.match(r'^\+\s*$', next_line)):  # List continuation
                 new_lines.append("")
                 changes_made = True
                 if verbose:
@@ -102,10 +109,13 @@ def process_file(file_path: Path, dry_run: bool = False, verbose: bool = False)
         # Check for block titles (.Title)
         elif not in_block and not in_comment_block and re.match(r'^\.[A-Z]', current_line):
             # Add blank line before block title if needed
-            if (prev_line and
+            # Don't add if inside a conditional block or if previous line is a conditional directive
+            if (not in_conditional and
+                prev_line and
                 not re.match(r'^\s*$', prev_line) and
                 not re.match(r'^=+\s+', prev_line) and
-                not re.match(r'^\[role=', prev_line)):  # Don't add if previous is heading, empty, or role block
+                not re.match(r'^\[role=', prev_line) and
+                not re.match(r'^(ifdef::|ifndef::|endif::)', prev_line)):  # Don't add if previous is conditional
                 new_lines.append("")
                 changes_made = True
                 if verbose:
@@ -117,11 +127,12 @@ def process_file(file_path: Path, dry_run: bool = False, verbose: bool = False)
         elif not in_block and re.match(r'^=+\s+', current_line):
             new_lines.append(current_line)
 
-            # Check if next line is not empty, not another heading, and not a comment block
+            # Check if next line is not empty, not another heading, not a comment block, and not a conditional
             if (next_line and
                 not re.match(r'^=+\s+', next_line) and
                 not re.match(r'^\s*$', next_line) and
-                not re.match(r'^////+$', next_line)):  # Don't add if next is comment block
+                not re.match(r'^////+$', next_line) and  # Don't add if next is comment block
+                not re.match(r'^(ifdef::|ifndef::|endif::)', next_line)):  # Don't add if next is conditional
                 new_lines.append("")
                 changes_made = True
                 if verbose:

doc_utils/version.py

@@ -1,7 +1,7 @@
 """Version information for doc-utils."""
 
 # This should match the version in pyproject.toml
-__version__ = "0.1.21"
+__version__ = "0.1.29"
 
 def get_version():
     """Return the current version string."""

doc_utils/version_check.py

@@ -141,10 +141,12 @@ def detect_install_method() -> str:
     Detect how the package was installed.
 
     Returns:
-        'pipx', 'pip', or 'unknown'
+        'pipx' or 'pip'
+
+    Note: Defaults to 'pipx' as the recommended installation method.
     """
-    # Check if running from pipx venv
-    if 'pipx' in sys.prefix:
+    # Check if running from pipx venv (standard pipx install)
+    if 'pipx' in sys.prefix.lower():
         return 'pipx'
 
     # Check PIPX_HOME environment variable
@@ -152,8 +154,17 @@ def detect_install_method() -> str:
     if pipx_home and str(Path(sys.prefix)).startswith(str(Path(pipx_home))):
         return 'pipx'
 
-    # Default to pip
-    return 'pip'
+    # Check if executable is in typical pipx bin location
+    try:
+        exe_path = Path(sys.executable)
+        if '.local/pipx' in str(exe_path):
+            return 'pipx'
+    except Exception:
+        pass
+
+    # Default to pipx as the recommended method (per CLAUDE.md guidelines)
+    # This ensures users see the recommended upgrade command even for editable installs
+    return 'pipx'
 
 
 def show_update_notification(latest_version: str, current_version: str = None):

doc_utils_cli.py

@@ -55,9 +55,14 @@ TOOLS = [
     },
     {
         'name': 'convert-callouts-to-deflist',
-        'description': 'Converts callout-style annotations to definition list format',
+        'description': 'Converts callouts to definition lists (batch mode)',
         'example': 'convert-callouts-to-deflist --dry-run modules/'
     },
+    {
+        'name': 'convert-callouts-interactive',
+        'description': 'Interactively converts callouts with per-block format selection',
+        'example': 'convert-callouts-interactive modules/'
+    },
 ]
 
 

{rolfedh_doc_utils-0.1.27.dist-info → rolfedh_doc_utils-0.1.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rolfedh-doc-utils
-Version: 0.1.27
+Version: 0.1.29
 Summary: CLI tools for AsciiDoc documentation projects
 Author: Rolfe Dlugy-Hegwer
 License: MIT License

{rolfedh_doc_utils-0.1.27.dist-info → rolfedh_doc_utils-0.1.29.dist-info}/RECORD

@@ -3,22 +3,22 @@ archive_unused_images.py,sha256=fZeyEZtTd72Gbd3YBXTy5xoshAAM9qb4qFPMjhHL1Fg,1864
 check_scannability.py,sha256=O6ROr-e624jVPvPpASpsWo0gTfuCFpA2mTSX61BjAEI,5478
 convert_callouts_interactive.py,sha256=hoDKff3jqyJiGZ3IqjcWF7AXM4XUQE-vVg2NpJYECs4,21066
 convert_callouts_to_deflist.py,sha256=MfNbbTzaODFIK6jdPdCoMCe27KqMjJFjdoIiGazm978,17852
-doc_utils_cli.py,sha256=dsMYrkAriYdZUF0_cSPh5DAPrJMPiecuY26xN-p0UJ0,4911
+doc_utils_cli.py,sha256=J3CE7cTDDCRGkhAknYejNWHhk5t9YFGt27WDVfR98Xk,5111
 extract_link_attributes.py,sha256=wR2SmR2la-jR6DzDbas2PoNONgRZ4dZ6aqwzkwEv8Gs,3516
 find_unused_attributes.py,sha256=77CxFdm72wj6SO81w-auMdDjnvF83jWy_qaM7DsAtBw,4263
 format_asciidoc_spacing.py,sha256=nmWpw2dgwhd81LXyznq0rT8w6Z7cNRyGtPJGRyKFRdc,4212
 replace_link_attributes.py,sha256=Cpc4E-j9j-4_y0LOstAKYOPl02Ln_2bGNIeqp3ZVCdA,7624
 validate_links.py,sha256=lWuK8sgfiFdfcUdSVAt_5U9JHVde_oa6peSUlBQtsac,6145
 callout_lib/__init__.py,sha256=8B82N_z4D1LaZVYgd5jZR53QAabtgPzADOyGlnvihj0,665
-callout_lib/converter_bullets.py,sha256=8P92QZ0PylrKRE7V-D3TVZCDH0ct3GRIonc7W5AK5uU,3898
+callout_lib/converter_bullets.py,sha256=ZYQIddaouEouPkrDRGIt8f35a1rO5M92Ry5Fi5ZL_2g,3926
 callout_lib/converter_comments.py,sha256=do0dH8uOyNFpn5CDEzR0jYYCMIPP3oPFM8cEB-Fp22c,9767
-callout_lib/converter_deflist.py,sha256=mQ17Y8gJLv0MzzJscpUL7ujuDRyEVcrb9lcPdUNkIX4,3117
-callout_lib/detector.py,sha256=yPikWkoZybd5GjooEv8xYd-iLQbHP09cNCp7HrcqWCA,13200
-callout_lib/table_parser.py,sha256=CaFOphhwONF4zQWeVVGZbB-rwF0Ety7R6My3V6ETdig,21119
+callout_lib/converter_deflist.py,sha256=ghXX04L1QRNfsSKGXZsL839IoC-bd8PiNdrSSw_clwI,3145
+callout_lib/detector.py,sha256=TYYcQjx77-aZe8A4MK5w_CTojGrOUb8qYjiwyXeJqCk,13699
+callout_lib/table_parser.py,sha256=_e-viN7ijrL2gFdjem5hYirJv_8HH9f67yWUDkiQflQ,21672
 doc_utils/__init__.py,sha256=qqZR3lohzkP63soymrEZPBGzzk6-nFzi4_tSffjmu_0,74
 doc_utils/extract_link_attributes.py,sha256=U0EvPZReJQigNfbT-icBsVT6Li64hYki5W7MQz6qqbc,22743
 doc_utils/file_utils.py,sha256=fpTh3xx759sF8sNocdn_arsP3KAv8XA6cTQTAVIZiZg,4247
-doc_utils/format_asciidoc_spacing.py,sha256=1pR0113ZS-BlxMNjTRT6cID_Nd2iAD-EfZ-9RW_3inA,12882
+doc_utils/format_asciidoc_spacing.py,sha256=RL2WU_dG_UfGL01LnevcyJfKsvYy_ogNyeoVX-Fyqks,13579
 doc_utils/replace_link_attributes.py,sha256=gmAs68_njBqEz-Qni-UGgeYEDTMxlTWk_IOm76FONNE,7279
 doc_utils/scannability.py,sha256=XwlmHqDs69p_V36X7DLjPTy0DUoLszSGqYjJ9wE-3hg,982
 doc_utils/spinner.py,sha256=lJg15qzODiKoR0G6uFIk2BdVNgn9jFexoTRUMrjiWvk,3554
@@ -27,11 +27,11 @@ doc_utils/unused_adoc.py,sha256=2cbqcYr1os2EhETUU928BlPRlsZVSdI00qaMhqjSIqQ,5263
 doc_utils/unused_attributes.py,sha256=OHyAdaBD7aNo357B0SLBN5NC_jNY5TWXMwgtfJNh3X8,7621
 doc_utils/unused_images.py,sha256=nqn36Bbrmon2KlGlcaruNjJJvTQ8_9H0WU9GvCW7rW8,1456
 doc_utils/validate_links.py,sha256=iBGXnwdeLlgIT3fo3v01ApT5k0X2FtctsvkrE6E3VMk,19610
-doc_utils/version.py,sha256=5Uc0sAUOkXA6R_PvDGjw2MBYptEKdav5XmeRqukMTo0,203
-doc_utils/version_check.py,sha256=eHJnZmBTbdhhY2fJQW9KnnyD0rWEvCZpMg6oSr0fOmI,7090
-rolfedh_doc_utils-0.1.27.dist-info/licenses/LICENSE,sha256=vLxtwMVOJA_hEy8b77niTkdmQI9kNJskXHq0dBS36e0,1075
-rolfedh_doc_utils-0.1.27.dist-info/METADATA,sha256=Kk9CDC-zzU6sDESsDr_zumWLMycacohrbLUq7_IWHKs,8325
-rolfedh_doc_utils-0.1.27.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rolfedh_doc_utils-0.1.27.dist-info/entry_points.txt,sha256=vL_LlLKOiurRzchrq8iRUQG19Xi9lSAFVZGjO-xyErk,577
-rolfedh_doc_utils-0.1.27.dist-info/top_level.txt,sha256=J4xtr3zoyCip27b3GnticFVZoyz5HHtgGqHQ-SZONCA,265
-rolfedh_doc_utils-0.1.27.dist-info/RECORD,,
+doc_utils/version.py,sha256=PtAQCWVDHYtUFsUMZHC3w-EKng1J_Gz6pROJlMpmBeI,203
+doc_utils/version_check.py,sha256=-31Y6AN0KGi_CUCAVOOhf6bPO3r7SQIXPxxeffLAF0w,7535
+rolfedh_doc_utils-0.1.29.dist-info/licenses/LICENSE,sha256=vLxtwMVOJA_hEy8b77niTkdmQI9kNJskXHq0dBS36e0,1075
+rolfedh_doc_utils-0.1.29.dist-info/METADATA,sha256=JWxEIXukWyk9q0pr4TeEMdeCCNSyvdgLpc28H3-oya4,8325
+rolfedh_doc_utils-0.1.29.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rolfedh_doc_utils-0.1.29.dist-info/entry_points.txt,sha256=vL_LlLKOiurRzchrq8iRUQG19Xi9lSAFVZGjO-xyErk,577
+rolfedh_doc_utils-0.1.29.dist-info/top_level.txt,sha256=J4xtr3zoyCip27b3GnticFVZoyz5HHtgGqHQ-SZONCA,265
+rolfedh_doc_utils-0.1.29.dist-info/RECORD,,