dxaws-website Documentation

dxaws-website is the orchestration module for converging a static website on AWS from typed desired state.

This docs set focuses on the manager-only public API:

  • WebsiteManager

  • ExecuteOptions / ApplyOptions

  • WebsiteDesired / WebsiteCurrent / WebsiteResult

Local preview (Sphinx)

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

Tip: during development, use python -m pip install -e ".[docs]".

Documentation map

  • usage.md: end-to-end WebsiteManager.execute() examples

  • design.md: architecture and convergence semantics

  • api.md: public exports and import paths

Testing note

Acceptance/integration tests are opt-in and may require real AWS credentials.