-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
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
- Export all documented functions from init.py (see related issue)
- Or update mkdocstrings paths to point to main module
- 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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation