Skip to content

quickstart.md

Latest commit

 

History

History
94 lines (61 loc) · 1.7 KB

quickstart.md

File metadata and controls

94 lines (61 loc) · 1.7 KB
Raw

Quick Start

Get started with DocGen in 5 minutes.

Step 1: Install

Install Doc-Gen from the private GitLab PyPI registry with a deploy token that has read_package_registry access:

python -m pip install \
  --index-url "https://<deploy-token-user>:<deploy-token>@gitlab.com/api/v4/projects/<project-id>/packages/pypi/simple" \
  "doc-gen==1.0.2"

Step 2: Verify Installation

Check that DocGen is installed:

doc-gen --help

You should see the help output.

Step 3: Generate Structure

Run the generate command:

doc-gen structure generate

This creates a PROJECT_STRUCTURE.md file in your current directory.

Step 4: View Output

Open the generated file:

# PROJECT_STRUCTURE.md

You should see your project structure.

Common Variations

Print to Console

Instead of saving to a file, print to console:

doc-gen structure print

Use Smart Mode

Let DocGen optimize automatically:

doc-gen structure generate --smart

Use a Profile

Choose a detail level:

# Minimal - just directories
doc-gen structure generate --profile minimal

# Detailed - everything
doc-gen structure generate --profile detailed

Configuration (Optional)

Create a .projectstructure.toml file:

[tool.doc-gen]
profile = "default"
max_depth = 3
show_files = true
smart_mode = true

Next Steps