AGENTS.md

Docbuild Project

This document outlines key information about the docbuild project to assist AI agents and developers.

Purpose of this Project (Docbuild)

Docbuild builds documentation from DocBook 5/ASCIIDoc, manages XML configs, clones repos, runs daps, handles metadata and syncing deliverables.

Repository Facts

• Python Version: >= 3.12
• Package Manager: uv (Astral)
• Key Directories:
  • src/: Source code
  • tests/: Test suite (pytest)
  • .github/workflows/: CI/CD configurations
• CLI Entry Point: docbuild (file src/docbuild/__main__.py)
• Documentation:* https://opensuse.github.io/docbuild/

Setup

1. Create a virtual environment with uv venv
2. Install dependencies: uv sync --frozen --group devel

Testing with uv

To run tests in this environment, use the following commands:

• Run complete test suite:

  uv run --frozen pytest

• Run single test file:

  uv run --frozen pytest tests/path/to/test_file.py