Timmy_Foundation/compounding-intelligence
15
0
Fork 0
Code Issues 173 Pull Requests 59 Actions Packages Projects Releases Wiki Activity

[4.3] Add API Doc Generator — issue #98 #252

Open
Rockachopa wants to merge 1 commits from step35/98-4-3-api-doc-generator into main
pull from: step35/98-4-3-api-doc-generator
merge into: Timmy_Foundation:main
Conversation 0 Commits 1 Files Changed 3 +839
Rockachopa commented 2026-04-26 11:03:00 +00:00
Owner
Copy Link

Adds the API Doc Generator: scripts/api_doc_generator.py.

What it does:

  • Scans all Python files in scripts/
  • Extracts module docstrings and public function signatures
  • Generates docs/API.md — one consolidated reference for the repo

Usage:

python3 scripts/api_doc_generator.py          # Generate docs/API.md
python3 scripts/api_doc_generator.py --check  # Verify docs are current
python3 scripts/api_doc_generator.py --json   # Machine-readable output

This PR

Documents 33 scripts with 100+ public functions. Includes 12 smoke tests.

Closes #98

Adds the API Doc Generator: `scripts/api_doc_generator.py`. What it does: - Scans all Python files in `scripts/` - Extracts module docstrings and public function signatures - Generates `docs/API.md` — one consolidated reference for the repo Usage: ```bash python3 scripts/api_doc_generator.py # Generate docs/API.md python3 scripts/api_doc_generator.py --check # Verify docs are current python3 scripts/api_doc_generator.py --json # Machine-readable output ``` ## This PR Documents **33 scripts** with 100+ public functions. Includes 12 smoke tests. Closes #98
Rockachopa added 1 commit 2026-04-26 11:03:01 +00:00
feat: add API Doc Generator — issue #98
Some checks failed
Test / pytest (pull_request) Failing after 7s
Details
5a6f41689f 
- scripts/api_doc_generator.py: AST-based scanner for scripts/ Python modules
- docs/API.md: generated API reference (33 modules, ~500 lines)
- tests/test_api_doc_generator.py: 12 smoke tests (all passing)

The generator extracts module docstrings and public function signatures (name, args, summary) and produces a markdown table per script. One consolidated document per repo (docs/API.md).

Closes #98
Some checks failed
Test / pytest (pull_request) Failing after 7s
Details
Checking for merge conflicts…
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin step35/98-4-3-api-doc-generator:step35/98-4-3-api-doc-generator
git checkout step35/98-4-3-api-doc-generator
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
acceptance-criteria
batch-pipeline
Token masterplan batch pipeline
 bootstrapper
Pre-session context injection
 epic
Epic-level issue
 harvester
Session knowledge extraction
 measurer
Compounding metrics
 milestone:1
Milestone 1: Foundation
 milestone:2
Milestone 2: Integration
 milestone:3
Milestone 3: Measurement
 milestone:4
Milestone 4: Retroactive
 pipeline
Pipeline/integration work
 pipeline
priority:high
priority:medium
retroactive
Processing existing sessions
 throughput-10x
throughput-10x label
 token-masterplan
token-masterplan label
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
Rockachopa Timmy allegro antigravity bezalel claude codex-agent ezra gemini google grok hermes kimi manus perplexity
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Timmy_Foundation/compounding-intelligence#252
Delete Branch "step35/98-4-3-api-doc-generator"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?