Subsystem: readmenator (page 2 of 5)

Previous: KB_readmenator.md

readmenator/_cursorrules_generator.py

• Doc: Dynamic .cursorrules generator for the readmenator knowledge graph.
• Layer: utility
• Language: py
• Symbols:
  • CursorRulesGenerator (class, line 18) class CursorRulesGenerator
  • __init__ (method, line 25) def __init__(self, config)
  • generate (method, line 28) def generate(self, nodes, edges, analysis, layers, violations, project_root)
  • _build_base_rules (method, line 63) def _build_base_rules(self)
  • _extract_layer_constraints (method, line 81) def _extract_layer_constraints(self, layers)
  • _extract_analysis_constraints (method, line 92) def _extract_analysis_constraints(self, analysis)
  • _extract_violation_rules (method, line 107) def _extract_violation_rules(self, violations)
  • _write_file (method, line 115) def _write_file(self, project_root, content)
• Depends on: readmenator/_config.py, readmenator/_layers.py, readmenator/_models.py
• Imported by: readmenator/_app.py, tests/test_cursorrules.py

readmenator/_dataflow.py

• Doc: Procedural intra-function dataflow analysis for readmenator.
• Layer: data_access
• Language: py
• Symbols:
  • _strip_noise (function, line 96) def _strip_noise(line)
  • _strip_block_comments (function, line 107) def _strip_block_comments(content)
  • _strip_sizeof (function, line 116) def _strip_sizeof(line)
  • DataflowAnalyzer (class, line 122) class DataflowAnalyzer
  • _blank (function, line 110) def _blank(match)
  • __init__ (method, line 125) def __init__(self, config)
  • analyze (method, line 129) def analyze(self, nodes, content_map)
  • _brace_depths (method, line 153) def _brace_depths(lines)
  • _function_spans (method, line 164) def _function_spans(self, node, total_lines, depths)
  • _analyze_function (method, line 191) def _analyze_function(self, file_id, func, lines, start, end)
  • _scan_reads (method, line 403) def _scan_reads(text, lineno, reads, assigned, declared_names)
  • _scan_inline_aliases (method, line 427) def _scan_inline_aliases(line, lineno, arrays, derived_alias, deriv_reads)
  • _scan_out_params (method, line 450) def _scan_out_params(line, lineno, assigned)
  • _scan_array_args (method, line 461) def _scan_array_args(line, lineno, arrays, assigned)
  • _params_of (method, line 474) def _params_of(signature_line)
  • _track_call_continuation (method, line 494) def _track_call_continuation(line, call_open, paren_balance)
  • _mentions_param (method, line 513) def _mentions_param(text, params)
  • _is_member (method, line 521) def _is_member(line, pos)
  • _member_base (method, line 527) def _member_base(line, pos)
  • _is_prototype (method, line 535) def _is_prototype(line)
  • _null_checked (method, line 540) def _null_checked(body_text, name)
• Depends on: readmenator/_config.py, readmenator/_models.py
• Imported by: readmenator/_pipeline.py, tests/test_dataflow.py

readmenator/_dead_code.py

• Doc: Dead code detection for the readmenator knowledge graph.
• Layer: utility
• Language: py
• Symbols:
  • DeadCodeStripper (class, line 17) class DeadCodeStripper
  • __init__ (method, line 25) def __init__(self, config)
  • identify (method, line 28) def identify(self, nodes, edges, resolved_edges)
  • _build_in_degree_map (method, line 64) def _build_in_degree_map(self, nodes, resolved_edges)
  • _classify_recommendation (method, line 88) def _classify_recommendation(self, symbol)
• Depends on: readmenator/_config.py, readmenator/_models.py
• Imported by: readmenator/_app.py, tests/test_dead_code.py

readmenator/_diagrams.py

• Doc: Self-contained interactive system maps for the knowledge graph.
• Layer: utility
• Language: py
• Symbols:
  • _escape_markup (function, line 33) def _escape_markup(value)
  • _json_payload (function, line 45) def _json_payload(payload)
  • _fill_template (function, line 57) def _fill_template(template, values)
  • _role_color (function, line 76) def _role_color(role, config)
  • MapNode (class, line 90) class MapNode
  • MapEdge (class, line 123) class MapEdge
  • MapView (class, line 140) class MapView
  • SystemMap (class, line 157) class SystemMap
  • MapDiagnostic (class, line 178) class MapDiagnostic
  • MapReceipt (class, line 195) class MapReceipt
  • MapDelta (class, line 212) class MapDelta
  • SystemMapValidator (class, line 232) class SystemMapValidator
  • SystemMapBuilder (class, line 456) class SystemMapBuilder
  • InteractiveMapRenderer (class, line 1522) class InteractiveMapRenderer
  • VisNetworkRenderer (class, line 2233) class VisNetworkRenderer
  • DocsSitePublisher (class, line 3225) class DocsSitePublisher
  • __init__ (method, line 235) def __init__(self, config)
  • _effective_canvas (method, line 243) def _effective_canvas(self, system_map)
  • validate (method, line 264) def validate(self, system_map)
  • __init__ (method, line 485) def __init__(self, config)
  • supported_kinds (method, line 494) def supported_kinds(self)
  • _is_full (method, line 502) def _is_full(self, full)
  • build (method, line 515) def build(self, nodes, edges, resolved_edges, layers, findings, analysis, kind, full)
  • _annotate_communities (method, line 557) def _annotate_communities(system_map, analysis)
  • build_all (method, line 574) def build_all(self, nodes, edges, resolved_edges, layers, findings, analysis, full)
  • compare (method, line 605) def compare(self, base, head)
  • _title_for (method, line 644) def _title_for(self, kind)
  • _role_for (method, line 658) def _role_for(self, group, sensitive)
  • _sensitive_files (method, line 675) def _sensitive_files(self, findings)
  • _ranked_file_ids (method, line 692) def _ranked_file_ids(self, nodes, links, analysis)
  • _select_primary (method, line 727) def _select_primary(self, nodes, links, analysis, full)
  • _internal_links (method, line 753) def _internal_links(self, edges, selected, full)
  • _symbol_records (method, line 776) def _symbol_records(self, node)
  • _short_label (method, line 798) def _short_label(self, value)
  • _layout_columns (method, line 813) def _layout_columns(self, items, kind, full)
  • _lanes_that_fit (method, line 861) def _lanes_that_fit(self, lanes)
  • _fitted_gap (method, line 878) def _fitted_gap(self, count, item, gap, total, margin)
  • _lane_capacity (method, line 902) def _lane_capacity(self)
  • _cap_lane_scope (method, line 916) def _cap_lane_scope(self, ranked, layer_of)
  • _layout_sequence (method, line 940) def _layout_sequence(self, ordered, full)
  • _sequence_capacity (method, line 977) def _sequence_capacity(self)
  • _place (method, line 991) def _place(self, ranked, layer_of, kind, full)
  • _canvas_for (method, line 1011) def _canvas_for(self, positions, full)
  • _meta_for (method, line 1029) def _meta_for(self, kind, placed, links, total, positions, full)
  • _make_views (method, line 1052) def _make_views(self, kind, primary, links)
  • _build_architecture (method, line 1124) def _build_architecture(self, nodes, links, layers, findings, analysis, full)
  • _build_workflow (method, line 1184) def _build_workflow(self, nodes, links, layers, findings, full)
  • _build_sequence (method, line 1264) def _build_sequence(self, nodes, links, layers, analysis, full)
  • _build_dataflow (method, line 1346) def _build_dataflow(self, nodes, links, layers, findings, full)
  • _build_lifecycle (method, line 1429) def _build_lifecycle(self, nodes, links, layers, findings, full)
  • __init__ (method, line 1525) def __init__(self, config)
  • _canvas_size (method, line 1533) def _canvas_size(self, system_map)
  • render (method, line 1554) def render(self, system_map)
  • write (method, line 1649) def write(self, system_map, output_path)
  • _safe_json (method, line 1668) def _safe_json(self, payload)
  • _escape (method, line 1679) def _escape(self, value)
  • _role_color (method, line 1690) def _role_color(self, role)
  • _edge_path (method, line 1701) def _edge_path(self, x1, y1, x2, y2)
  • _nodes_svg (method, line 1737) def _nodes_svg(self, system_map)
  • _edges_svg (method, line 1785) def _edges_svg(self, system_map)
  • _template (method, line 1832) def _template(self)
  • __init__ (method, line 2241) def __init__(self, config)
  • render (method, line 2249) def render(self, system_map)
  • _community_legend (method, line 2355) def _community_legend(self, system_map)
  • write (method, line 2375) def write(self, system_map, output_path)
  • _tooltip (method, line 2392) def _tooltip(self, node)
  • _template (method, line 2423) def _template(self)
  • __init__ (method, line 3242) def __init__(self, config)
  • description_for (method, line 3252) def description_for(self, kind)
  • publish (method, line 3266) def publish(self, maps, project_name, output_dir, stats, renderer, project_root, video_rel, doc_entries, extra_cards)
  • collect_doc_sources (method, line 3360) def collect_doc_sources(self, project_root)
  • publish_assets (method, line 3386) def publish_assets(self, project_root, output_dir)
  • _render_poster (method, line 3455) def _render_poster(self, video, site_root)
  • _doc_title (method, line 3493) def _doc_title(text)
  • _doc_preview (method, line 3502) def _doc_preview(self, text)
  • _prune_stale_docs (method, line 3538) def _prune_stale_docs(docs_root, keep)
  • render_llms_txt (method, line 3555) def render_llms_txt(self, project_name, maps, stats, href_prefix, doc_entries)
  • render_index (method, line 3634) def render_index(self, project_name, maps, stats, href_prefix, video_rel, doc_entries, poster_rel, extra_cards)
  • _brand_block (method, line 3712) def _brand_block(self)
  • _project_pills (method, line 3739) def _project_pills(self)
  • _footer (method, line 3768) def _footer(self)
  • _stat_tiles (method, line 3832) def _stat_tiles(self, stats)
  • _start_here (method, line 3852) def _start_here(self, entries, video_rel)
  • _video_section (method, line 3892) def _video_section(self, video_rel, poster_rel)
  • _doc_group (method, line 3919) def _doc_group(self, name)
  • _docs_section (method, line 3931) def _docs_section(self, doc_entries)
  • _href_prefix (method, line 4013) def _href_prefix(self)
  • _viewer_modal (method, line 4024) def _viewer_modal(self)
  • _viewer_script (method, line 4030) def _viewer_script(self)
  • _viewer_css (method, line 4043) def _viewer_css(self)
  • _glyph (method, line 4069) def _glyph(self, kind)
  • _card (method, line 4087) def _card(self, kind, system_map, href_prefix)
  • _extra_card (method, line 4128) def _extra_card(self, entry)
  • _stats_line (method, line 4159) def _stats_line(self, stats)
  • _escape (method, line 4173) def _escape(self, value)
  • order (function, line 3606) def order(entry)
  • doc_order (function, line 3957) def doc_order(base)
• Depends on: readmenator/_config.py, readmenator/_folder_readme.py, readmenator/_htmlpack.py, readmenator/_models.py, readmenator/_project_config.py, readmenator/_viewer_ui.py
• Imported by: readmenator/__init__.py, readmenator/_app.py, readmenator/_pipeline.py, tests/test_agent_friendliness.py, tests/test_components.py, tests/test_diagrams.py, tests/test_folder_readme.py, tests/test_interactive_graph.py, tests/test_project_config.py

readmenator/_docstrings.py

• Doc: Multi-style docstring parser for the deterministic API reference.
• Layer: utility
• Language: py
• Symbols:
  • DocField (class, line 135) class DocField
  • DocComment (class, line 161) class DocComment
  • clean_text (function, line 230) def clean_text(text)
  • detect_style (function, line 254) def detect_style(text)
  • split_summary (function, line 293) def split_summary(text)
  • _indent (function, line 321) def _indent(line)
  • _join_block (function, line 326) def _join_block(lines)
  • _section_key (function, line 331) def _section_key(header)
  • _apply_section (function, line 336) def _apply_section(doc, key, body, item_mode)
  • _strip_fence (function, line 372) def _strip_fence(text)
  • _split_refs (function, line 382) def _split_refs(text)
  • _parse_items (function, line 393) def _parse_items(body, mode, allow_bare)
  • _parse_return (function, line 480) def _parse_return(body, mode)
  • _parse_sections (function, line 498) def _parse_sections(text, mode)
  • _parse_rest (function, line 551) def _parse_rest(text)
  • _extract_doctests (function, line 642) def _extract_doctests(text)
  • _parse_jsdoc_param (function, line 664) def _parse_jsdoc_param(rest)
  • _parse_tags (function, line 690) def _parse_tags(text)
  • _xml_inline (function, line 767) def _xml_inline(text)
  • _parse_xml (function, line 778) def _parse_xml(text)
  • parse_docstring (function, line 809) def parse_docstring(text)
  • _strip_line_prefix (function, line 874) def _strip_line_prefix(line, prefixes)
  • _elixir_doc (function, line 888) def _elixir_doc(lines, index, lookback)
  • recover_comment (function, line 910) def recover_comment(content_lines, line, language, lookback)
  • to_dict (method, line 150) def to_dict(self)
  • is_empty (method, line 195) def is_empty(self)
  • param (method, line 203) def param(self, name)
  • to_dict (method, line 211) def to_dict(self)
  • flush (function, line 413) def flush()
  • grab (function, line 782) def grab(tag)
• Imported by: readmenator/_apidocs.py, readmenator/_apidocs_render.py, tests/test_apidocs.py

readmenator/_documentation.py

• Doc: KNOWLEDGE_BASE.md generator: the human-facing architecture reference.
• Layer: utility
• Language: py
• Symbols:
  • DocumentationGenerator (class, line 36) class DocumentationGenerator
  • __init__ (method, line 48) def __init__(self, config)
  • _ranking_version (method, line 71) def _ranking_version(self)
  • _get_git_commit (method, line 89) def _get_git_commit()
  • generate (method, line 99) def generate(self, nodes, edges, resolved_edges, analysis, layers, findings, analysis_v2, ranked, content_map)
  • _apply_context_budget (method, line 217) def _apply_context_budget(self, content, nodes, edges, resolved_edges, analysis, analysis_v2, findings)
  • _build_toc (method, line 355) def _build_toc(self, nodes, analysis, layers, findings, analysis_v2, is_truncated, ranked, extra_sections)
  • _build_layers (method, line 458) def _build_layers(self, layers, nodes)
  • _build_dashboard (method, line 492) def _build_dashboard(self, nodes, edges, resolved_edges)
  • _build_god_nodes (method, line 572) def _build_god_nodes(self, analysis, ranked)
  • _build_community_analysis (method, line 600) def _build_community_analysis(self, analysis, nodes)
  • _build_surprising_connections (method, line 633) def _build_surprising_connections(self, analysis, nodes)
  • _build_suggested_questions (method, line 658) def _build_suggested_questions(self, analysis)
  • _build_forcegraph_section (method, line 674) def _build_forcegraph_section(self, nodes, edges, resolved_edges, analysis, layers, findings)
  • _build_analytics_section (method, line 711) def _build_analytics_section(self, nodes, edges, resolved_edges, analysis, layers, findings, analysis_v2)
  • _build_ranked_context (method, line 746) def _build_ranked_context(self, ranked)
  • _build_orphans (method, line 792) def _build_orphans(self, nodes, analysis_v2, ranked)
  • _build_query_recipes (method, line 842) def _build_query_recipes(self)
  • _build_taint_analysis (method, line 884) def _build_taint_analysis(self, analysis_v2)
  • _build_hotspots (method, line 919) def _build_hotspots(self, analysis_v2, ranked)
  • _build_dataflow_analysis (method, line 957) def _build_dataflow_analysis(self, analysis_v2)
  • _build_concept_graph (method, line 988) def _build_concept_graph(self, analysis_v2)
  • _build_dependency_cycles (method, line 1035) def _build_dependency_cycles(self, analysis_v2)
  • _build_change_impact (method, line 1056) def _build_change_impact(self, analysis_v2)
  • _build_layer_violations (method, line 1081) def _build_layer_violations(self, analysis_v2)
  • _build_suggested_rules (method, line 1109) def _build_suggested_rules(self, analysis_v2)
  • _build_security_findings (method, line 1134) def _build_security_findings(self, findings)
  • _build_mermaid_section (method, line 1181) def _build_mermaid_section(self, graph_output, is_truncated)
  • _build_uml_diagram (method, line 1204) def _build_uml_diagram(self, nodes, edges)
  • _build_cpg_block (method, line 1249) def _build_cpg_block(self, nodes, edges, resolved_edges, analysis)
  • _build_architecture_reference (method, line 1275) def _build_architecture_reference(self, nodes, edges)
• Depends on: readmenator/_analytics.py, readmenator/_config.py, readmenator/_cpg.py, readmenator/_flowcharts.py, readmenator/_forcegraph.py, readmenator/_mermaid.py, readmenator/_models.py, readmenator/_rank.py, readmenator/_uml.py
• Imported by: readmenator/_pipeline.py, tests/test_documentation.py, tests/test_flowcharts.py

readmenator/_embed.py

• Doc: Optional semantic embeddings for the readmenator knowledge graph.
• Layer: utility
• Language: py
• Symbols:
  • _tokens (function, line 22) def _tokens(text)
  • _jaccard (function, line 27) def _jaccard(left, right)
  • Embedder (class, line 39) class Embedder
  • __init__ (method, line 42) def __init__(self, config)
  • dependencies_available (method, line 50) def dependencies_available(self)
  • encode (method, line 58) def encode(self, texts)
  • near_jaccard (method, line 75) def near_jaccard(self, query, corpus, top_k)
  • cluster_jaccard (method, line 99) def cluster_jaccard(self, corpus, threshold)
  • project_jaccard (method, line 138) def project_jaccard(self, corpus)
  • find (function, line 115) def find(item)
  • union (function, line 122) def union(left, right)
• Depends on: readmenator/_config.py
• Imported by: readmenator/_pipeline.py, tests/test_interactive_graph.py

readmenator/_exclusions.py

• Doc: False-positive exclusion list for readmenator findings.
• Layer: utility
• Language: py
• Symbols:
  • ExclusionEntry (class, line 19) class ExclusionEntry
  • ExclusionList (class, line 44) class ExclusionList
  • parse_exclusions (function, line 114) def parse_exclusions(text)
  • _to_entry (function, line 146) def _to_entry(data)
  • _unquote (function, line 157) def _unquote(value)
  • matches (method, line 27) def matches(self, file_path, rule_id)
  • __init__ (method, line 47) def __init__(self, config)
  • entries (method, line 58) def entries(self)
  • load (method, line 62) def load(self, project_root)
  • is_excluded (method, line 86) def is_excluded(self, file_path, rule_id)
  • filter_findings (method, line 98) def filter_findings(self, findings)
• Depends on: readmenator/_config.py
• Imported by: readmenator/_pipeline.py, tests/test_interactive_graph.py

readmenator/_explain.py

• Doc: Score explanation and path decomposition for the ranking system.
• Layer: utility
• Language: py
• Symbols:
  • explain_rank (function, line 16) def explain_rank(node_id, ranked, category)
  • rank_summary (function, line 140) def rank_summary(ranked, top_n)
  • _find_item (function, line 163) def _find_item(node_id, items)
• Depends on: readmenator/_category.py, readmenator/_rank.py
• Imported by: tests/test_ranking.py

readmenator/_explorer.py

• Doc: Stdlib explorer HTTP server for the readmenator knowledge graph.
• Layer: utility
• Language: py
• Symbols:
  • ExplorerState (class, line 23) class ExplorerState
  • _Handler (class, line 105) class _Handler(BaseHTTPRequestHandler)
  • find_free_port (function, line 169) def find_free_port(preferred)
  • serve (function, line 188) def serve(state, host, port, open_browser)
  • build_state (function, line 221) def build_state(config, nodes, edges, resolved_edges, analysis, findings, layers, content_map)
  • write_static (function, line 249) def write_static(state, output_dir, filename)
  • __init__ (method, line 26) def __init__(self, config, nodes, edges, resolved_edges, analysis, findings, layers, content_map)
  • samples (method, line 64) def samples(self)
  • source (method, line 80) def source(self, file_id)
  • log_message (method, line 108) def log_message(self, fmt)
  • do_GET (method, line 112) def do_GET(self)
  • _serve_html (method, line 135) def _serve_html(self)
  • _serve_vendor (method, line 144) def _serve_vendor(self)
  • _serve_json (method, line 158) def _serve_json(self, payload)
• Depends on: readmenator/_analytics.py, readmenator/_config.py, readmenator/_forcegraph.py, readmenator/_models.py, readmenator/_sourceview.py
• Imported by: readmenator/_app.py, tests/test_interactive_graph.py

readmenator/_exporter.py

• Doc: Multi-format exporter for the readmenator knowledge graph.
• Layer: utility
• Language: py
• Symbols:
  • GraphExporter (class, line 28) class GraphExporter
  • __init__ (method, line 36) def __init__(self, config)
  • to_json (method, line 44) def to_json(self, nodes, edges, resolved_edges, analysis, findings, concept_graph)
  • to_html (method, line 183) def to_html(self, nodes, edges, resolved_edges, analysis, findings)
  • _community_color_map (method, line 272) def _community_color_map(self, analysis)
  • _lighten (method, line 290) def _lighten(hex_color)
  • _render_html (method, line 298) def _render_html(self, vis_nodes, vis_edges, analysis, findings)
  • to_svg (method, line 482) def to_svg(self, nodes, edges, resolved_edges, analysis)
  • _render_truncated_svg (method, line 600) def _render_truncated_svg(self, total_nodes)
  • _layout_spring (method, line 615) def _layout_spring(self, nodes, edges, node_map)
  • to_graphml (method, line 696) def to_graphml(self, nodes, edges, resolved_edges, analysis)
  • to_cypher (method, line 773) def to_cypher(self, nodes, edges, resolved_edges, analysis, findings, concept_graph)
  • to_obsidian (method, line 895) def to_obsidian(self, nodes, edges, output_dir, analysis, concept_graph)
  • to_forcegraph (method, line 1020) def to_forcegraph(self, nodes, edges, resolved_edges, analysis, layers, findings, analytics)
  • _project (function, line 544) def _project(pos)
  • _sev_span (function, line 370) def _sev_span(sev, count)
• Depends on: readmenator/_analytics.py, readmenator/_config.py, readmenator/_forcegraph.py, readmenator/_models.py
• Imported by: readmenator/_pipeline.py, tests/test_exporter.py, tests/test_interactive_graph.py

readmenator/_flowcharts.py

• Doc: Architecture and execution-flow Mermaid diagrams from static structure.
• Layer: utility
• Language: py
• Symbols:
  • mermaid_id (function, line 67) def mermaid_id(text, prefix)
  • mermaid_text (function, line 72) def mermaid_text(text, limit)
  • tarjan_scc (function, line 80) def tarjan_scc(vertices, adjacency)
  • transitive_reduction (function, line 134) def transitive_reduction(adjacency)
  • eades_lin_smyth (function, line 185) def eades_lin_smyth(vertices, weight)
  • Component (class, line 237) class Component
  • ArchitectureDiagramBuilder (class, line 259) class ArchitectureDiagramBuilder
  • EntryPoint (class, line 499) class EntryPoint
  • FlowStep (class, line 523) class FlowStep
  • ExecutionFlowBuilder (class, line 543) class ExecutionFlowBuilder
  • _first_sentence (function, line 927) def _first_sentence(text)
  • _ControlFlowBuilder (class, line 936) class _ControlFlowBuilder
  • to_mermaid (function, line 1170) def to_mermaid(graph, direction)
  • build_flow_graphs (function, line 1231) def build_flow_graphs(config, nodes, edges, resolved_edges, content_map, analysis, layers)
  • render_architecture_section (function, line 1287) def render_architecture_section(config, nodes, resolved_edges, analysis, layers)
  • render_flows_section (function, line 1319) def render_flows_section(config, nodes, edges, resolved_edges, content_map)
  • reachable (function, line 149) def reachable(vertex)
  • live (function, line 211) def live(table)
  • __init__ (method, line 262) def __init__(self, config)
  • components (method, line 270) def components(self, nodes, analysis, layers)
  • model (method, line 335) def model(self, nodes, resolved_edges, analysis, layers)
  • render (method, line 476) def render(self, nodes, resolved_edges, analysis, layers)
  • _heavy_threshold (method, line 490) def _heavy_threshold(counts)
  • key (method, line 517) def key(self)
  • __init__ (method, line 546) def __init__(self, config)
  • _is_test (method, line 555) def _is_test(self, file_id)
  • call_graph (method, line 564) def call_graph(self, nodes, edges, resolved_edges, content_map)
  • entry_points (method, line 645) def entry_points(self, nodes, graph, defs, content_map)
  • walk (method, line 723) def walk(self, graph, start)
  • _short (method, line 754) def _short(self, key)
  • _definition_detail (method, line 764) def _definition_detail(self, key, defs)
  • call_tree_model (method, line 779) def call_tree_model(self, entry, steps, defs)
  • call_tree_mermaid (method, line 827) def call_tree_mermaid(self, entry, steps, defs)
  • sequence_model (method, line 831) def sequence_model(self, entry, steps, defs)
  • sequence_mermaid (method, line 862) def sequence_mermaid(self, entry, steps, defs)
  • control_flow_model (method, line 877) def control_flow_model(self, content, entry, project_names, defs, call_graph)
  • control_flow_mermaid (method, line 921) def control_flow_mermaid(self, content, entry, project_names)
  • __init__ (method, line 948) def __init__(self, config, project_names, summaries, file_id)
  • _new (method, line 958) def _new(self, shape, title, lines, tone, line, calls)
  • _link (method, line 969) def _link(self, src, dst, label, style)
  • _calls (method, line 973) def _calls(self, node)
  • _call_lines (method, line 987) def _call_lines(self, calls)
  • build (method, line 994) def build(self, body, title)
  • _connect (method, line 1012) def _connect(self, tails, target)
  • _block (method, line 1017) def _block(self, body, tails)
  • _case_of (method, line 1074) def _case_of(test)
  • _compound (method, line 1094) def _compound(self, stmt, tails)
  • label (function, line 1182) def label(node)
  • declare (function, line 1187) def declare(node, indent)
  • caller_key (function, line 596) def caller_key(site_file, site_line, caller)
  • bump (function, line 668) def bump(file_id, name, line, points, reason)
  • visit (function, line 738) def visit(caller, depth, path)
  • add (function, line 800) def add(key, tone)
  • flush (function, line 1022) def flush()
• Depends on: readmenator/_apidocs.py, readmenator/_config.py, readmenator/_flowlayout.py, readmenator/_models.py, readmenator/_pytypes.py, readmenator/_symindex.py
• Imported by: readmenator/_app.py, readmenator/_documentation.py, readmenator/_video.py, tests/test_flowcharts.py

readmenator/_flowlayout.py

• Doc: Flow graph model and deterministic layered layout (Sugiyama style).
• Layer: utility
• Language: py
• Symbols:
  • FlowNode (class, line 36) class FlowNode
  • FlowEdge (class, line 67) class FlowEdge
  • FlowGraph (class, line 86) class FlowGraph
  • LayoutMetrics (class, line 146) class LayoutMetrics
  • _wrap (function, line 180) def _wrap(lines, metrics)
  • measure (function, line 195) def measure(node, metrics)
  • _ranks (function, line 210) def _ranks(graph)
  • layout_flow (function, line 260) def layout_flow(graph, metrics, direction)
  • layout_sequence (function, line 414) def layout_sequence(graph, metrics)
  • node (method, line 117) def node(self, node_id)
  • to_dict (method, line 124) def to_dict(self)
• Imported by: readmenator/_apidocs_page.py, readmenator/_apidocs_render.py, readmenator/_app.py, readmenator/_flowcharts.py, readmenator/_flowpage.py, tests/test_flowcharts.py

readmenator/_flowpage.py

• Doc: Interactive SVG viewer for laid-out architecture and execution-flow diagrams.
• Layer: utility
• Language: py
• Symbols:
  • flows_payload_json (function, line 225) def flows_payload_json(graphs, api_href)
  • render_flows_page (function, line 231) def render_flows_page(graphs, project_name, api_href, config)
  • flow_thumbnail_svg (function, line 264) def flow_thumbnail_svg(graph, width, height)
• Depends on: readmenator/_config.py, readmenator/_flowlayout.py, readmenator/_htmlpack.py, readmenator/_project_config.py, readmenator/_viewer_ui.py
• Imported by: readmenator/_apidocs_page.py, readmenator/_apidocs_render.py, readmenator/_app.py, tests/test_flowcharts.py, tests/test_project_config.py

readmenator/_folder_readme.py

• Doc: Per-folder README.md files for every generated readmenator-* directory.
• Layer: utility
• Language: py
• Symbols:
  • FolderSpec (class, line 27) class FolderSpec
  • is_generated_folder_readme (function, line 45) def is_generated_folder_readme(path, config)
  • FolderReadmeWriter (class, line 65) class FolderReadmeWriter
  • __init__ (method, line 68) def __init__(self, config)
  • specs (method, line 76) def specs(self)
  • render (method, line 272) def render(self, spec, folder)
  • write_all (method, line 310) def write_all(self, project_root)
• Depends on: readmenator/_config.py
• Imported by: readmenator/_agent_output.py, readmenator/_diagrams.py, readmenator/_gh_wiki.py, readmenator/_pipeline.py, tests/test_folder_readme.py, tests/test_project_config.py

readmenator/_forcegraph.py

• Doc: Force-graph explorer for the readmenator knowledge graph.
• Layer: utility
• Language: py
• Symbols:
  • family_color_from_name (function, line 41) def family_color_from_name(name, sat_base, sat_span, light_base, light_span)
  • node_value (function, line 69) def node_value(symbols, degree)
  • ForceGraphRenderer (class, line 82) class ForceGraphRenderer
  • __init__ (method, line 85) def __init__(self, config)
  • node_palette (method, line 93) def node_palette(self)
  • edge_palette (method, line 97) def edge_palette(self)
  • vendor_source (method, line 101) def vendor_source(self)
  • vendor_href (method, line 109) def vendor_href(self)
  • build_payload (method, line 114) def build_payload(self, nodes, edges, resolved_edges, analysis, layers, findings, content_map)
  • _seed_positions (method, line 316) def _seed_positions(self, payload)
  • render (method, line 359) def render(self, payload, analytics, title, home_href, live_api)
  • group_colors (method, line 413) def group_colors(self, payload)
  • page_settings (method, line 436) def page_settings(self, payload, live_api)
  • family_color (method, line 512) def family_color(self, name)
  • _family_color (method, line 523) def _family_color(self, name)
  • thumbnail_svg (method, line 540) def thumbnail_svg(self, payload)
  • write (method, line 580) def write(self, output_path, payload, analytics, title, home_href)
  • copy_vendor (method, line 607) def copy_vendor(self, dest_dir)
  • _node_doc (method, line 626) def _node_doc(self, node)
  • _symbol_list (method, line 632) def _symbol_list(self, node)
  • _file_color (method, line 645) def _file_color(self, node_id, family, layer, palette)
  • file_of (function, line 150) def file_of(edge_id)
  • add_node (function, line 204) def add_node(node_id, label, node_type)
• Depends on: readmenator/_config.py, readmenator/_forcegraph_page.py, readmenator/_graphlayout.py, readmenator/_htmlpack.py, readmenator/_models.py, readmenator/_project_config.py, readmenator/_purpose.py, readmenator/_rank.py, readmenator/_resolver.py, readmenator/_sourceview.py, readmenator/_viewer_ui.py
• Imported by: readmenator/_bundlegraph.py, readmenator/_documentation.py, readmenator/_explorer.py, readmenator/_exporter.py, readmenator/_pipeline.py, tests/test_bundlegraph.py, tests/test_interactive_graph.py, tests/test_layout_quality.py, tests/test_project_config.py, tests/test_sourceview.py

readmenator/_forcegraph_page.py

• Doc: HTML page template for the force-graph explorer.
• Layer: presentation
• Language: py
• Imported by: readmenator/_forcegraph.py, tests/test_layout_quality.py, tests/test_project_config.py

Next: KB_readmenator_p3.md