{escape_html(app_name)} - CLI Documentation

') # Determine the app name and full command path if not command_chain: # Root level - use app name or derive from sys.argv app_name = app.name[0] full_command = app_name title = app_name # Add title for all levels lines.append(f'{title}') else: # Nested command - build full path app_name = command_chain[0] if command_chain else app.name[0] full_command = " ".join(command_chain) # Create anchor-friendly ID anchor_id = f"{app_name}-{'-'.join(command_chain[1:])}" anchor_id = anchor_id.lower().replace(" ", "-") lines.append('

') lines.append( f'{escape_html(full_command)}' ) # Add application description help_format = app.app_stack.resolve("help_format", fallback="restructuredtext") description = BaseDocGenerator.extract_description(app, help_format) if description: desc_text = extract_text(description, None) if desc_text: lines.append(f'

{escape_html(desc_text)}

') # Generate table of contents if this is the root level and has commands if generate_toc and not command_chain and app._commands: lines.append('

') lines.append("

") lines.append("

") _generate_html_toc(lines, app, include_hidden, app_name, "", 0) lines.append("") lines.append("

") # Add usage section if not suppressed usage = BaseDocGenerator.extract_usage(app) if usage: lines.append(f"Usage") lines.append('

') if isinstance(usage, str): usage_text = usage else: usage_text = extract_text(usage, None) usage_text = BaseDocGenerator.format_usage_line(usage_text, command_chain, prefix="$") lines.append(f'

{escape_html(usage_text)}

') lines.append("

") # Get help panels for the current app help_panels_with_groups = app._assemble_help_panels([], help_format) # Render panels formatter = HtmlFormatter( heading_level=heading_level + 1, include_hidden=include_hidden, app_name=app_name, command_chain=command_chain, ) formatter.reset() for group, panel in help_panels_with_groups: if not include_hidden and group and not group.show: continue # Filter out entries based on include_hidden if not include_hidden: panel.entries = BaseDocGenerator.filter_help_entries(panel, include_hidden) if panel.entries: # Only render non-empty panels formatter(None, None, panel) panel_docs = formatter.get_output().strip() if panel_docs: lines.append(panel_docs) # Handle recursive documentation for subcommands if app._commands: # Iterate through registered commands for name, subapp in BaseDocGenerator.iterate_commands(app, include_hidden): # Build the command chain for this subcommand sub_command_chain = BaseDocGenerator.build_command_chain(command_chain, name, app_name) # Determine heading level for subcommand if flatten_commands: sub_heading_level = heading_level else: sub_heading_level = heading_level + 1 # Generate subcommand documentation lines.append('

') # Create anchor-friendly ID anchor_id = ( f"{app_name}-{'-'.join(sub_command_chain[1:])}".lower() if len(sub_command_chain) > 1 else f"{app_name}-{name}".lower() ) lines.append( f'{escape_html(" ".join(sub_command_chain))}' ) # Get subapp help with subapp.app_stack([subapp]): sub_help_format = subapp.app_stack.resolve("help_format", fallback=help_format) sub_description = BaseDocGenerator.extract_description(subapp, sub_help_format) if sub_description: sub_desc_text = extract_text(sub_description, None) if sub_desc_text: lines.append(f'

{escape_html(sub_desc_text)}

') # Generate usage for subcommand sub_usage = BaseDocGenerator.extract_usage(subapp) if sub_usage: if flatten_commands: usage_heading_level = heading_level + 1 else: usage_heading_level = heading_level + 2 lines.append(f"Usage") lines.append('

') if isinstance(sub_usage, str): sub_usage_text = sub_usage else: sub_usage_text = extract_text(sub_usage, None) sub_usage_text = BaseDocGenerator.format_usage_line(sub_usage_text, sub_command_chain, prefix="$") lines.append(f'

{escape_html(sub_usage_text)}

') lines.append("

") # Only show subcommand panels if we're in recursive mode if recursive: # Get help panels for subcommand sub_panels = subapp._assemble_help_panels([], sub_help_format) # Render subcommand panels if flatten_commands: panel_heading_level = heading_level + 1 else: panel_heading_level = heading_level + 2 sub_formatter = HtmlFormatter( heading_level=panel_heading_level, include_hidden=include_hidden, app_name=app_name, command_chain=sub_command_chain, ) for sub_group, sub_panel in sub_panels: if not include_hidden and sub_group and not sub_group.show: continue # Filter out built-in commands if not including hidden if not include_hidden: sub_panel.entries = [ e for e in sub_panel.entries if not ( e.names and all( n.startswith("--help") or n.startswith("--version") or n == "-h" for n in e.names ) ) ] if sub_panel.entries: sub_formatter(None, None, sub_panel) sub_panel_docs = sub_formatter.get_output().strip() if sub_panel_docs: lines.append(sub_panel_docs) # Recursively handle nested subcommands if recursive and subapp._commands: for nested_name, nested_app in BaseDocGenerator.iterate_commands(subapp, include_hidden): # Build nested command chain nested_chain = BaseDocGenerator.build_command_chain(sub_command_chain, nested_name, app_name) # Determine heading level for nested commands if flatten_commands: nested_heading_level = heading_level else: nested_heading_level = heading_level + 2 # Recursively generate docs for nested commands nested_docs = generate_html_docs( nested_app, recursive=recursive, include_hidden=include_hidden, heading_level=nested_heading_level, standalone=False, # Not standalone for nested custom_css=None, command_chain=nested_chain, # Pass the command chain generate_toc=False, # No TOC for nested commands flatten_commands=flatten_commands, ) lines.append(nested_docs) # Add back to top link if we're in a nested section if command_chain: lines.append('↑ Back to top') lines.append("

") # Close section if nested command if command_chain: lines.append("

") # Only close cli-documentation div for standalone or root if standalone or not command_chain: lines.append("

Table of Contents