|
10 | 10 | - [generators](#generators) (15 modules) |
11 | 11 | - [sync](#sync) (3 modules) |
12 | 12 |
|
13 | | -## Core |
14 | | - |
15 | 13 | ### `analyzers` [source](https://github.com/wronai/code2docs/blob/main/code2docs/analyzers/__init__.py) |
16 | 14 |
|
17 | 15 | | Class | Methods | Description | Source | |
|
272 | 270 | |----------|-----------|----|----------- |--------| |
273 | 271 | | `start_watcher` | `start_watcher(project_path, config)` | 5 | Start watching project for file changes and auto-resync docs. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/sync/watcher.py#L10) | |
274 | 272 |
|
275 | | -## analyzers |
276 | | - |
277 | 273 | ### `analyzers.dependency_scanner` [source](https://github.com/wronai/code2docs/blob/main/code2docs/analyzers/dependency_scanner.py) |
278 | 274 |
|
279 | 275 | | Class | Methods | Description | Source | |
|
312 | 308 | |----------|-----------|----|----------- |--------| |
313 | 309 | | `analyze_and_document` | `analyze_and_document(project_path, config)` | 1 | Convenience function: analyze a project in one call. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/analyzers/project_scanner.py#L39) | |
314 | 310 |
|
315 | | -## formatters |
316 | | - |
317 | 311 | ### `formatters.badges` [source](https://github.com/wronai/code2docs/blob/main/code2docs/formatters/badges.py) |
318 | 312 |
|
319 | 313 | | Function | Signature | CC | Description | Source | |
|
348 | 342 | | `extract_headings` | `extract_headings(content, max_depth)` | 6 | Extract headings from Markdown content. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/formatters/toc.py#L30) | |
349 | 343 | | `generate_toc` | `generate_toc(markdown_content, max_depth)` | 3 | Generate a table of contents from Markdown headings. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/formatters/toc.py#L7) | |
350 | 344 |
|
351 | | -## generators |
352 | | - |
353 | 345 | ### `generators._registry_adapters` [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/_registry_adapters.py) |
354 | 346 |
|
355 | 347 | | Class | Methods | Description | Source | |
|
542 | 534 | |----------|-----------|----|----------- |--------| |
543 | 535 | | `generate_readme` | `generate_readme(project_path, output, sections, sync_markers, ...)` | 3 | Convenience function to generate a README. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L446) | |
544 | 536 |
|
545 | | -## sync |
546 | | - |
547 | 537 | ### `sync.differ` [source](https://github.com/wronai/code2docs/blob/main/code2docs/sync/differ.py) |
548 | 538 |
|
549 | 539 | | Class | Methods | Description | Source | |
|
0 commit comments