Documentation

Python Requirement

Certain components of this package require Python 3.11 or higher. Please ensure your environment meets this requirement to use all features without compatibility issues.

Overview

This package provides a comprehensive toolkit for creating and managing project documentation efficiently. Designed to automate documentation generation, it ensures consistency across projects while reducing manual effort and maintenance overhead.

Key Features

• Automatic Documentation Generation: Creates required documentation files with minimal input

• Consistency Management: Tools to maintain uniform structure and formatting across all project documentation

• Styling Utilities: Provides consistent look and feel for all Arqh AG projects

• Development Workflow: Live reloading and preview capabilities for efficient editing

Getting Started

Once your virtual environment is activated, the pydocs command-line interface provides the following workflow commands:

pydocs [COMMAND] [OPTIONS]

Available Commands

initialize - Set up a new documentation project

Initializes a new documentation project in a docs subdirectory of the current directory.

Options:

--name [NAME] - Custom name for the documentation project (optional)

Example:

pydocs initialize --name "MyProjectDocs"

dev - Development mode with live reload

Runs the documentation server with live reloading for real-time preview of changes.

Example:

pydocs dev

build - Production build

Generates optimized documentation files ready for deployment or distribution.

Example:

pydocs build

Getting Help

For detailed information on any command, use the help option:

pydocs [COMMAND] --help