Skip to content

Fix API Reference Documentation #14

@jtdub

Description

@jtdub

Problem

The API reference documentation uses mkdocstrings syntax but functions like process_configs, format_output, etc. are not exported from init.py, so mkdocstrings cannot find them. This likely results in missing or broken documentation.

Current State

The init.py only exports cli and version, but the API reference tries to document process_configs, format_output, get_output_text, setup_logging, etc.

Proposed Solution

  1. Export all documented functions from init.py (see related issue)
  2. Or update mkdocstrings paths to point to main module
  3. Verify documentation builds without errors by running mkdocs serve

Acceptance Criteria

  • All API reference entries resolve correctly
  • mkdocs build completes without warnings
  • Add CI check for documentation build

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions