scaffold

Scaffold templates for ``autoredocs init``. Contains the template strings and helpers that generate a ready-to-deploy project setup in a single command.

📄 /home/runner/work/autoredocs/autoredocs/src/autoredocs/scaffold.py

F write_workflow F write_env_example F update_gitignore

Functions

def

def write_workflow(project_dir: Path, source: str = './src') -> Path | None

Create ``.github/workflows/autoredocs.yml`` for GitHub Pages deployment. Returns the path to the created file, or None if it already exists.

📍 Line 110

def

def write_env_example(project_dir: Path) -> Path | None

Create ``.env.example`` with placeholder environment variables. Returns the path to the created file, or None if it already exists.

📍 Line 129

def

def update_gitignore(project_dir: Path) -> bool

Append autoredocs entries to ``.gitignore`` if not already present. Returns True if entries were added, False if they were already there.

📍 Line 142

scaffold

Contents

Functions