| Name | zerodoc-gen JSON |
| Version |
1.4.3
JSON |
| download |
| home_page | None |
| Summary | Zero-config documentation generator with beautiful UI |
| upload_time | 2025-08-07 20:26:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
documentation
generator
python
typer
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ZeroDoc - Zero-Config Documentation Generator
**Generate beautiful documentation from your codebase with zero configuration.**
ZeroDoc scans your project, extracts API information, and creates a clean, searchable documentation website - all with a single command.
## 🚀 Features
- **Multi-Language Support**: Python, JavaScript, TypeScript, Go, Rust, Java, C/C++, and more
- **Zero Configuration**: Works out of the box with any project
- **AST-based Parsing**: Accurately extracts API information using language-specific parsers
- **Markdown Generation**: Creates clean, readable markdown documentation
- **Static Site Export**: Converts docs to a beautiful HTML site
- **Jinja2 Templates**: Customizable README and documentation templates
- **CLI Interface**: Simple commands powered by Typer
- **Fast & Lightweight**: Generates docs in seconds, not minutes
## 📦 Installation
```bash
# Install from PyPI
pip install zerodoc-gen
# Or use pipx for isolated installation
pipx install zerodoc-gen
# Install from source
git clone https://github.com/yourusername/zerodoc.git
cd zerodoc
pip install -e .
```
## 🎯 Quick Start
```bash
# Generate documentation for your project
autodoc scan . # Scan codebase and create API JSON
autodoc readme # Generate/update README.md
autodoc docs . # Generate markdown documentation
autodoc export --serve # Export as static site and serve locally
```
## 📚 Commands
### `autodoc scan`
Scans your Python codebase and extracts API information into a JSON file.
```bash
autodoc scan [PATH] --out build/api.json --verbose
```
### `autodoc readme`
Generates or updates README.md using a Jinja2 template.
```bash
autodoc readme [PROJECT_PATH] --template default --force
```
### `autodoc docs`
Generates markdown documentation for all modules.
```bash
autodoc docs [PATH] --output docs --verbose
```
### `autodoc export`
Exports markdown docs as a static HTML site.
```bash
autodoc export --source docs --dest site --theme simple --serve
```
## 💡 Why ZeroDoc?
- **Cost-Effective**: Free and open-source vs $65-79/month for GitBook
- **Developer-First**: Built by developers, for developers
- **No Lock-in**: Your docs stay in your repo as markdown
- **CI/CD Ready**: Integrate with GitHub Actions for automatic doc updates
- **Fast**: Generates docs for large codebases in seconds
## 🛠️ Development
```bash
# Clone the repository
git clone https://github.com/yourusername/zerodoc.git
cd zerodoc
# Install in development mode
pip install -e ".[dev]"
# Run on itself to test
autodoc scan .
autodoc docs .
autodoc export --serve
```
## 🌍 Supported Languages
ZeroDoc supports documentation generation for:
- **Python**: Full AST-based parsing with docstrings, type hints, decorators
- **JavaScript/TypeScript**: Classes, functions, async/await, ES6+ features
- **Go**: Packages, structs, interfaces, methods, goroutines
- **Rust**: Structs, enums, traits, impl blocks, lifetimes
- **Java**: Classes, interfaces, generics, annotations
- **C/C++**: Classes, structs, functions, templates
- **Ruby, PHP, Swift, Kotlin**: Basic support via tree-sitter
- **And more**: 40+ languages supported through tree-sitter
## 🤝 Contributing
We welcome contributions! Here are some good first issues:
1. **Improve language parsers**: Enhance extraction for specific languages
2. **Improve themes**: Add more CSS themes or Tailwind support
3. **Git integration**: Auto-commit docs on successful generation
4. **AI enrichment**: Use LLMs to enhance documentation
## 📊 Statistics
- Lines of Code: < 1000
- Dependencies: Minimal (typer, jinja2, markdown-it-py)
- Performance: Processes 1000+ files in < 5 seconds
- Memory: < 50MB for large codebases
## 🗺️ Roadmap
- [ ] Multi-language support (JavaScript, TypeScript, Go, Rust)
- [ ] Plugin system for custom processors
- [ ] Docusaurus/MkDocs export formats
- [ ] API change detection and PR comments
- [ ] Local AI integration for doc enhancement
- [ ] Search functionality in exported sites
## 📄 License
MIT License - see [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- Built with [Typer](https://typer.tiangolo.com/) - The amazing CLI framework
- Inspired by the need for affordable, quality documentation tools
- Thanks to all contributors and early adopters
---
*Stop paying for expensive doc platforms. Start using ZeroDoc.*
Raw data
{
"_id": null,
"home_page": null,
"name": "zerodoc-gen",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "documentation, generator, python, typer, cli",
"author": null,
"author_email": "AutoDoc Team <ryan@ryankatayi.com>",
"download_url": "https://files.pythonhosted.org/packages/85/b9/4f852f97716320caa296c2bff53eaaa628967e21aee1339082fbd803cf5b/zerodoc_gen-1.4.3.tar.gz",
"platform": null,
"description": "# ZeroDoc - Zero-Config Documentation Generator\n\n**Generate beautiful documentation from your codebase with zero configuration.**\n\nZeroDoc scans your project, extracts API information, and creates a clean, searchable documentation website - all with a single command.\n\n## \ud83d\ude80 Features\n\n- **Multi-Language Support**: Python, JavaScript, TypeScript, Go, Rust, Java, C/C++, and more\n- **Zero Configuration**: Works out of the box with any project\n- **AST-based Parsing**: Accurately extracts API information using language-specific parsers\n- **Markdown Generation**: Creates clean, readable markdown documentation\n- **Static Site Export**: Converts docs to a beautiful HTML site\n- **Jinja2 Templates**: Customizable README and documentation templates\n- **CLI Interface**: Simple commands powered by Typer\n- **Fast & Lightweight**: Generates docs in seconds, not minutes\n\n## \ud83d\udce6 Installation\n\n```bash\n# Install from PyPI\npip install zerodoc-gen\n\n# Or use pipx for isolated installation\npipx install zerodoc-gen\n\n# Install from source\ngit clone https://github.com/yourusername/zerodoc.git\ncd zerodoc\npip install -e .\n```\n\n## \ud83c\udfaf Quick Start\n\n```bash\n# Generate documentation for your project\nautodoc scan . # Scan codebase and create API JSON\nautodoc readme # Generate/update README.md\nautodoc docs . # Generate markdown documentation\nautodoc export --serve # Export as static site and serve locally\n```\n\n## \ud83d\udcda Commands\n\n### `autodoc scan`\nScans your Python codebase and extracts API information into a JSON file.\n\n```bash\nautodoc scan [PATH] --out build/api.json --verbose\n```\n\n### `autodoc readme`\nGenerates or updates README.md using a Jinja2 template.\n\n```bash\nautodoc readme [PROJECT_PATH] --template default --force\n```\n\n### `autodoc docs`\nGenerates markdown documentation for all modules.\n\n```bash\nautodoc docs [PATH] --output docs --verbose\n```\n\n### `autodoc export`\nExports markdown docs as a static HTML site.\n\n```bash\nautodoc export --source docs --dest site --theme simple --serve\n```\n\n## \ud83d\udca1 Why ZeroDoc?\n\n- **Cost-Effective**: Free and open-source vs $65-79/month for GitBook\n- **Developer-First**: Built by developers, for developers\n- **No Lock-in**: Your docs stay in your repo as markdown\n- **CI/CD Ready**: Integrate with GitHub Actions for automatic doc updates\n- **Fast**: Generates docs for large codebases in seconds\n\n## \ud83d\udee0\ufe0f Development\n\n```bash\n# Clone the repository\ngit clone https://github.com/yourusername/zerodoc.git\ncd zerodoc\n\n# Install in development mode\npip install -e \".[dev]\"\n\n# Run on itself to test\nautodoc scan .\nautodoc docs .\nautodoc export --serve\n```\n\n## \ud83c\udf0d Supported Languages\n\nZeroDoc supports documentation generation for:\n\n- **Python**: Full AST-based parsing with docstrings, type hints, decorators\n- **JavaScript/TypeScript**: Classes, functions, async/await, ES6+ features \n- **Go**: Packages, structs, interfaces, methods, goroutines\n- **Rust**: Structs, enums, traits, impl blocks, lifetimes\n- **Java**: Classes, interfaces, generics, annotations\n- **C/C++**: Classes, structs, functions, templates\n- **Ruby, PHP, Swift, Kotlin**: Basic support via tree-sitter\n- **And more**: 40+ languages supported through tree-sitter\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions! Here are some good first issues:\n\n1. **Improve language parsers**: Enhance extraction for specific languages\n2. **Improve themes**: Add more CSS themes or Tailwind support\n3. **Git integration**: Auto-commit docs on successful generation\n4. **AI enrichment**: Use LLMs to enhance documentation\n\n## \ud83d\udcca Statistics\n\n- Lines of Code: < 1000\n- Dependencies: Minimal (typer, jinja2, markdown-it-py)\n- Performance: Processes 1000+ files in < 5 seconds\n- Memory: < 50MB for large codebases\n\n## \ud83d\uddfa\ufe0f Roadmap\n\n- [ ] Multi-language support (JavaScript, TypeScript, Go, Rust)\n- [ ] Plugin system for custom processors\n- [ ] Docusaurus/MkDocs export formats\n- [ ] API change detection and PR comments\n- [ ] Local AI integration for doc enhancement\n- [ ] Search functionality in exported sites\n\n## \ud83d\udcc4 License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n## \ud83d\ude4f Acknowledgments\n\n- Built with [Typer](https://typer.tiangolo.com/) - The amazing CLI framework\n- Inspired by the need for affordable, quality documentation tools\n- Thanks to all contributors and early adopters\n\n---\n\n\n*Stop paying for expensive doc platforms. Start using ZeroDoc.*\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Zero-config documentation generator with beautiful UI",
"version": "1.4.3",
"project_urls": {
"Documentation": "https://autodoc-typer.readthedocs.io",
"Homepage": "https://github.com/autodoc-team/autodoc-typer",
"Issues": "https://github.com/autodoc-team/autodoc-typer/issues",
"Repository": "https://github.com/autodoc-team/autodoc-typer"
},
"split_keywords": [
"documentation",
" generator",
" python",
" typer",
" cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "17b1011498f1a371259570ff5ed382cb8d50906d3389c89813cddac4b6d42ed4",
"md5": "97f5cd7f1e2508a8548cd83c4efa4991",
"sha256": "f26940611fc7f911b03284ef71fc042e4b104f26c0c6c9048bc2bc91f689d778"
},
"downloads": -1,
"filename": "zerodoc_gen-1.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "97f5cd7f1e2508a8548cd83c4efa4991",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 55775,
"upload_time": "2025-08-07T20:26:23",
"upload_time_iso_8601": "2025-08-07T20:26:23.909536Z",
"url": "https://files.pythonhosted.org/packages/17/b1/011498f1a371259570ff5ed382cb8d50906d3389c89813cddac4b6d42ed4/zerodoc_gen-1.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "85b94f852f97716320caa296c2bff53eaaa628967e21aee1339082fbd803cf5b",
"md5": "6342c683a09d34a5ca1ed2eb085463e8",
"sha256": "6f9d85d38b645ef4de72a55e1cdff822d23378884b669f1e6a41acf63616add9"
},
"downloads": -1,
"filename": "zerodoc_gen-1.4.3.tar.gz",
"has_sig": false,
"md5_digest": "6342c683a09d34a5ca1ed2eb085463e8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 54667,
"upload_time": "2025-08-07T20:26:25",
"upload_time_iso_8601": "2025-08-07T20:26:25.689553Z",
"url": "https://files.pythonhosted.org/packages/85/b9/4f852f97716320caa296c2bff53eaaa628967e21aee1339082fbd803cf5b/zerodoc_gen-1.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-07 20:26:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "autodoc-team",
"github_project": "autodoc-typer",
"github_not_found": true,
"lcname": "zerodoc-gen"
}
