Skip to content

Commit

Permalink
v0.1.7
Browse files Browse the repository at this point in the history
Fix entry point and add tqdm dependency
  • Loading branch information
ci-psy committed Jan 2, 2025
1 parent 954a073 commit 6b41924
Show file tree
Hide file tree
Showing 12 changed files with 1,309 additions and 78 deletions.
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
include LICENSE
include README.md
recursive-include docgen *.py
include docgen.py
include requirements.txt
130 changes: 127 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,11 @@ A powerful documentation generator that creates beautiful Markdown documentation
6. [Interactive Wizard Features](#interactive-wizard-features)
7. [Examples](#examples)
8. [Output Customization](#output-customization)
9. [Contributing](#contributing)
10. [License](#license)
9. [Supported Languages](#supported-languages)
10. [Configuration](#configuration)
11. [Troubleshooting](#troubleshooting)
12. [Contributing](#contributing)
13. [License](#license)

---

Expand All @@ -27,7 +30,12 @@ A powerful documentation generator that creates beautiful Markdown documentation
- 🔍 Smart file filtering by extension
- 📊 Detailed file statistics and analytics
- ⚡ Fast project reports for quick insights
- 🎨 Syntax highlighting for multiple languages
- 🎨 Language-aware code blocks for:
- Python, JavaScript, TypeScript
- Swift, Metal
- C, C++
- HTML, CSS
- JSON, YAML, Markdown
- 📋 Optional line numbers in code blocks
- 🔗 Clickable navigation with customizable anchors
- 📦 Large file chunking for better performance
Expand All @@ -41,6 +49,13 @@ A powerful documentation generator that creates beautiful Markdown documentation
- Python 3.7 or higher
- Works on Windows, macOS, and Linux

### Dependencies
- `tqdm`: Progress bar visualization for documentation generation
- Core Python libraries: `pathlib`, `typing`, `dataclasses` (for Python < 3.7)

> **Note**
> All dependencies will be automatically installed when using pip installation methods.
---

## Installation
Expand Down Expand Up @@ -232,6 +247,115 @@ py-code-docgen . --chunk-size 100 --collapsible-level all

---

## Supported Languages

DocGen automatically detects and applies language-specific formatting for:

| Language/Format | Extensions |
|----------------|------------|
| Python | `.py` |
| JavaScript | `.js` |
| TypeScript | `.ts` |
| Swift | `.swift` |
| Metal | `.metal` |
| C++ | `.cpp`, `.h` |
| C | `.c` |
| HTML | `.html` |
| CSS | `.css` |
| JSON | `.json` |
| YAML | `.yml`, `.yaml` |
| Markdown | `.md` |

The actual syntax highlighting in the generated documentation depends on your Markdown viewer's capabilities.

## Configuration

### File Filtering

- Use `.gitignore`-style patterns to exclude files/directories:
```bash
py-code-docgen --exclude "node_modules/,*.test.js"
```

### Large Files

- Control chunk size for better performance:
```bash
py-code-docgen --chunk-size 100 # Split files into 100-line chunks
```

### Output Format

- **Minimal Mode**: Clean, compact output
```bash
py-code-docgen --minimal
```

- **Full Mode**: Detailed documentation with all features
```bash
py-code-docgen --show-all --line-numbers --path-info
```

### Progress Indicators

- Show progress during generation:
```bash
py-code-docgen --show-progress
```

## Troubleshooting

### Common Issues

1. **Virtual Environment Activation**
- Issue: `command not found: py-code-docgen`
- Solution: Ensure virtual environment is activated:
```bash
source venv/bin/activate # macOS/Linux
venv\Scripts\activate.bat # Windows
```

2. **Large Files**
- Issue: Documentation generation is slow or memory-intensive
- Solution: Adjust chunk size:
```bash
py-code-docgen --chunk-size 50 # Smaller chunks
```

3. **Unicode/Encoding**
- Issue: Special characters appear garbled
- Solution: Ensure files are UTF-8 encoded

4. **Permission Issues**
- Issue: Cannot read certain files
- Solution: Check file permissions or run with appropriate privileges

### Version Information

Check your installed version:
```bash
py-code-docgen --version
```

### Getting Help

1. Run the interactive wizard:
```bash
py-code-docgen -i
```

2. View all options:
```bash
py-code-docgen --help
```

3. Generate a fast report:
```bash
py-code-docgen --fast-report
```

---

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.
Expand Down
Binary file removed dist/py_code_docgen-0.1.6-py3-none-any.whl
Binary file not shown.
Binary file removed dist/py_code_docgen-0.1.6.tar.gz
Binary file not shown.
Loading

0 comments on commit 6b41924

Please sign in to comment.