Merge pull request #31 from AllenInstitute/feature/add-mkdocs

Add documentation page (powered by mkdocs)

Author: rpmcginty

.github/workflows/publish_docs.yml

@@ -0,0 +1,27 @@
+name: Publish Docs
+on:
+  push:
+    branches: [main]
+    paths: [mkdocs.yml, docs/**, src/**]
+  workflow_dispatch:
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Sync dependencies
+        run: make install
+      - name: Build site
+        run: make docs-build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: build/documentation/site
+          publish_branch: gh-pages
+          force_orphan: true

Makefile

@@ -150,6 +150,17 @@ coverage-server: install ## Run coverage server
 
 .PHONY: coverage-server
 
+########################
+##@ Documentation Commands
+########################
+
+docs-serve: .uv ## Serve MkDocs site locally
+	uv run mkdocs serve --watch-theme
+
+docs-build: .uv ## Build MkDocs site into build/documentation/site
+	uv run mkdocs build --clean
+
+.PHONY: docs-serve docs-build
 
 #####################
 ##@ Docker Commands

README.md

@@ -1,5 +1,6 @@
 # AIBS Informatics AWS Lambda
 
+[![Docs](https://img.shields.io/badge/docs-online-blue.svg)](https://alleninstitute.github.io/aibs-informatics-aws-lambda/)
 [![Build Status](https://github.com/AllenInstitute/aibs-informatics-aws-lambda/actions/workflows/build.yml/badge.svg)](https://github.com/AllenInstitute/aibs-informatics-aws-lambda/actions/workflows/build.yml)
 [![codecov](https://codecov.io/gh/AllenInstitute/aibs-informatics-aws-lambda/graph/badge.svg?token=SEHNFMIX4G)](https://codecov.io/gh/AllenInstitute/aibs-informatics-aws-lambda)
 

docs/api/common/api/handler.md

@@ -0,0 +1,7 @@
+# API Lambda Handler
+
+Base class for creating API Gateway Lambda handlers.
+
+---
+
+::: aibs_informatics_aws_lambda.common.api.handler

docs/api/common/api/resolver.md

@@ -0,0 +1,7 @@
+# API Resolver
+
+Utility class for building API Gateway resolvers.
+
+---
+
+::: aibs_informatics_aws_lambda.common.api.resolver

docs/api/common/base.md

@@ -0,0 +1,7 @@
+# Base
+
+Base utilities and helpers for Lambda handlers.
+
+---
+
+::: aibs_informatics_aws_lambda.common.base

docs/api/common/handler.md

@@ -0,0 +1,7 @@
+# Lambda Handler
+
+Base class for creating strongly typed Lambda functions with serialization, logging, and metrics support.
+
+---
+
+::: aibs_informatics_aws_lambda.common.handler

docs/api/common/index.md

@@ -0,0 +1,27 @@
+# Common
+
+The `common` module provides base classes and utilities for creating Lambda handlers.
+
+## Overview
+
+| Module | Description |
+|--------|-------------|
+| [Handler](handler.md) | `LambdaHandler` base class |
+| [Base](base.md) | Base utilities and helpers |
+| [Logging](logging.md) | Logging configuration and utilities |
+| [Metrics](metrics.md) | Metrics collection utilities |
+| [Models](models.md) | Common data models |
+| [API](api/handler.md) | API Gateway handler utilities |
+
+## Quick Start
+
+```python
+from aibs_informatics_aws_lambda.common.handler import LambdaHandler
+
+class MyHandler(LambdaHandler):
+    def handle(self, event, context):
+        return {"status": "success"}
+
+# Export handler for AWS Lambda
+handler = MyHandler().get_handler()
+```

docs/api/common/logging.md

@@ -0,0 +1,7 @@
+# Logging
+
+Logging configuration and utilities for Lambda handlers.
+
+---
+
+::: aibs_informatics_aws_lambda.common.logging

docs/api/common/metrics.md

@@ -0,0 +1,7 @@
+# Metrics
+
+Metrics collection utilities for Lambda handlers.
+
+---
+
+::: aibs_informatics_aws_lambda.common.metrics