File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Production Deployment - Socratic Docs
2+
3+ Automated documentation generation and management.
4+
5+ ## Production Checklist
6+
7+ - [x] Automated code extraction and parsing
8+ - [x] Documentation generation from source
9+ - [x] Git integration for version tracking
10+ - [x] Multi-format output (Markdown, HTML, PDF)
11+ - [x] Project structure management
12+ - [x] CI/CD integration support
13+
14+ ## Setup
15+
16+ ``` python
17+ from socratic_docs import DocumentationGenerator
18+
19+ gen = DocumentationGenerator(
20+ project_path = ' /path/to/project' ,
21+ output_format = ' markdown' ,
22+ )
23+
24+ # Generate comprehensive documentation
25+ gen.generate_all()
26+
27+ # Outputs to ./docs/
28+ ```
29+
30+ ## Git Integration
31+
32+ ``` python
33+ # Track documentation in git
34+ gen.commit_changes(
35+ message = " docs: auto-generated from code" ,
36+ author = " Documentation Bot" ,
37+ )
38+
39+ # Keep docs in sync with code
40+ ```
41+
42+ ## CI/CD Integration
43+
44+ ``` yaml
45+ # In GitHub Actions
46+ - name : Generate Documentation
47+ run : |
48+ pip install socratic-docs
49+ socratic-docs generate
50+ git add docs/
51+ git commit -m "docs: auto-generated"
52+ git push
53+ ` ` `
54+
You can’t perform that action at this time.
0 commit comments