dxaws-core Documentation

Core utilities for dxaws modules

Overview

This repository contains the dxaws-core dxaws module.

Version: 0.1.1

The documentation in this directory is designed to be:

• Buildable standalone with Sphinx

• Readable directly on GitHub

• Aggregated into the main dxaws documentation site

Local preview (Sphinx)

python -m pip install ".[docs]"
cd docs
make html
open _build/html/index.html

Tip: if you’re actively developing the module, use: python -m pip install -e ".[docs]"

Notes

• Documentation is written in Markdown (MyST-compatible).

• API reference pages are generated from docstrings.

• This docs content is intentionally tool-agnostic; if you prefer MkDocs, the Markdown in docs/ is compatible by design (we may add a mkdocs.yml later).