Skip to content

Commit 411cc76

Browse files
refactoring
1 parent c624cce commit 411cc76

11 files changed

Lines changed: 53 additions & 1495 deletions

File tree

code2docs/CONTRIBUTING.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Contributing to code2docs
2-
31
## Development Setup
42

53
```bash
@@ -28,10 +26,3 @@ python -m unittest discover tests/
2826

2927
Follow PEP 8 conventions.
3028

31-
## Pull Request Guidelines
32-
33-
- Keep PRs focused — one feature or fix per PR
34-
- Include tests for new functionality
35-
- Update documentation if needed
36-
- Ensure all tests pass before submitting
37-
- Use descriptive commit messages

code2docs/README.md

Lines changed: 53 additions & 1141 deletions
Large diffs are not rendered by default.

code2docs/docs/api-changelog.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

code2docs/docs/api.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
- [generators](#generators) (15 modules)
1111
- [sync](#sync) (3 modules)
1212

13-
## Core
14-
1513
### `analyzers` [source](https://github.com/wronai/code2docs/blob/main/code2docs/analyzers/__init__.py)
1614

1715
| Class | Methods | Description | Source |
@@ -272,8 +270,6 @@
272270
|----------|-----------|----|----------- |--------|
273271
| `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) |
274272

275-
## analyzers
276-
277273
### `analyzers.dependency_scanner` [source](https://github.com/wronai/code2docs/blob/main/code2docs/analyzers/dependency_scanner.py)
278274

279275
| Class | Methods | Description | Source |
@@ -312,8 +308,6 @@
312308
|----------|-----------|----|----------- |--------|
313309
| `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) |
314310

315-
## formatters
316-
317311
### `formatters.badges` [source](https://github.com/wronai/code2docs/blob/main/code2docs/formatters/badges.py)
318312

319313
| Function | Signature | CC | Description | Source |
@@ -348,8 +342,6 @@
348342
| `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) |
349343
| `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) |
350344

351-
## generators
352-
353345
### `generators._registry_adapters` [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/_registry_adapters.py)
354346

355347
| Class | Methods | Description | Source |
@@ -542,8 +534,6 @@
542534
|----------|-----------|----|----------- |--------|
543535
| `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) |
544536

545-
## sync
546-
547537
### `sync.differ` [source](https://github.com/wronai/code2docs/blob/main/code2docs/sync/differ.py)
548538

549539
| Class | Methods | Description | Source |

code2docs/docs/architecture.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,6 @@ graph TD
8585
- `analyzers.endpoint_detector`
8686
- `analyzers.project_scanner`
8787

88-
### Core
89-
90-
- `base`
91-
9288
### API / CLI
9389

9490
- `cli`

code2docs/docs/coverage.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

code2docs/docs/dependency-graph.md

Lines changed: 0 additions & 163 deletions
This file was deleted.

code2docs/docs/getting-started.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Getting Started with code2docs
2-
31
## Prerequisites
42

53
- Python >=3.9
@@ -19,11 +17,6 @@ cd code2docs
1917
pip install -e .
2018
```
2119

22-
## Quick Start
23-
24-
### Command Line
25-
26-
```bash
2720
# Generate full documentation for your project
2821
code2docs ./path/to/your/project
2922

0 commit comments

Comments
 (0)