Development Setup

Python 3.9+

Siapkan editable Doc Gen environment yang menyediakan pytest, Ruff, Black, pre-commit, dan packaging tools.

Commandpython -m pip install -e ".[dev]"

Quick Command

create venv -> install dev tools -> enable hooks

editable installpytestRuffBlackpre-commit

Package Python

3.9 atau lebih baru

Standard Dev Runtime

Python 3.14

Install Mode

Editable

Optional Helper

GNU Make

Tujuan

Gunakan isolated environment dengan command doc-gen yang memuat active checkout. Install .[dev]; runtime-only editable installation tidak menyertakan pytest, Ruff, Black, atau pre-commit.

Requirements

Python 3.9+

Required

Package mendukung Python 3.9 atau lebih baru; Python 3.14 adalah standard development dan container runtime.

pip dan venv

Required

Install Doc Gen dan quality tools ke isolated environment.

Git

Required

Diperlukan untuk source control dan pre-commit hook workflow.

GNU Make

Optional

Menyediakan setup, QA, Docker, dan Compose targets yang konsisten.

Docker

Optional

Hanya diperlukan untuk container dan Compose validation.

Manual Setup

Create and install

bash

python -m venv venv

# Windows PowerShell

venv\Scripts\Activate.ps1

# Linux or macOS

# source venv/bin/activate

python -m pip install --upgrade pip
python -m pip install -e ".[dev]"

Gunakan python -m pip install -e ".[dev,docs]" hanya ketika mengerjakan MkDocs source milik repository.

Makefile Setup

Setup helpers

bash

make venv
make upgrade-pip
make install-dev

# Combined environment setup and Git-hook installation

make setup

Make workflow menggunakan Python interpreter dalam directory konvensional venv/.

Pre-Commit Workflow

Hook configuration Doc Gen menjalankan Ruff fixes, Ruff formatting, Black, trailing-whitespace cleanup, dan final-newline correction. Ruff dan Black membaca project policy dari pyproject.toml.

Install and run hooks

bash

make pre-commit-install-hooks
make pre-commit-validate
make pre-commit-run-staged
make pre-commit-run

Verify the Environment

Before You Begin

Python didukungRequired
python --version melaporkan supported interpreter.
Editable CLI dapat dijalankanRequired
doc-gen --help dimuat dari environment yang dipilih.
Quality tools tersediaRequired
pytest, Ruff, Black, dan pre-commit dapat dijalankan melalui python -m.
Validation menggunakan safe targetsRequired
Gunakan temporary projects dan dry-run sebelum memvalidasi live generated output.

Environment check

bash

python --version
python -m pip show doc-gen
doc-gen --help
python -m pytest --version
python -m ruff --version
python -m black --version
python -m pre_commit --version

Related Commands

Commands commonly used together with this command.

Testing

Validasi structure dan output behavior.

Contributing

Ikuti Doc Gen review workflow.

Getting Started

Pelajari end-user setup dan penggunaan pertama.

Generate

Pahami writable structure command.

Tujuan​

Tujuan