Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Deploy Docs

on:
push:
branches: [main]
tags: ["v*.*.*"]

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- run: pip install mkdocs-material mkdocstrings[python]
- run: mkdocs build
- uses: actions/upload-pages-artifact@v3
with:
path: site/

deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/deploy-pages@v4
id: deployment
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[![License](https://img.shields.io/github/license/opendecree/decree-python)](LICENSE)
[![Project Status: WIP](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![codecov](https://codecov.io/gh/opendecree/decree-python/graph/badge.svg)](https://codecov.io/gh/opendecree/decree-python)
[![Docs](https://img.shields.io/badge/docs-opendecree.github.io-teal)](https://opendecree.github.io/decree-python)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/opendecree/decree-python)

Python SDK for [OpenDecree](https://github.com/opendecree/decree) — schema-driven configuration management.
Expand Down
155 changes: 155 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
# API Reference

Auto-generated from source docstrings.

## Clients

### ConfigClient

::: opendecree.ConfigClient
options:
show_source: false

### AsyncConfigClient

::: opendecree.AsyncConfigClient
options:
show_source: false

## Watchers

### ConfigWatcher

::: opendecree.ConfigWatcher
options:
show_source: false

### WatchedField

::: opendecree.WatchedField
options:
show_source: false

### AsyncConfigWatcher

::: opendecree.AsyncConfigWatcher
options:
show_source: false

### AsyncWatchedField

::: opendecree.AsyncWatchedField
options:
show_source: false

## Data Types

### Change

::: opendecree.Change
options:
show_source: false

### FieldUpdate

::: opendecree.FieldUpdate
options:
show_source: false

### ServerVersion

::: opendecree.ServerVersion
options:
show_source: false

### RetryConfig

::: opendecree.RetryConfig
options:
show_source: false

## Exceptions

### DecreeError

::: opendecree.DecreeError
options:
show_source: false

### NotFoundError

::: opendecree.NotFoundError
options:
show_source: false

### AlreadyExistsError

::: opendecree.AlreadyExistsError
options:
show_source: false

### InvalidArgumentError

::: opendecree.InvalidArgumentError
options:
show_source: false

### LockedError

::: opendecree.LockedError
options:
show_source: false

### ChecksumMismatchError

::: opendecree.ChecksumMismatchError
options:
show_source: false

### PermissionDeniedError

::: opendecree.PermissionDeniedError
options:
show_source: false

### UnavailableError

::: opendecree.UnavailableError
options:
show_source: false

### TypeMismatchError

::: opendecree.TypeMismatchError
options:
show_source: false

### IncompatibleServerError

::: opendecree.IncompatibleServerError
options:
show_source: false

### TimeoutError

::: opendecree.TimeoutError
options:
show_source: false

### ResourceExhaustedError

::: opendecree.ResourceExhaustedError
options:
show_source: false

### CancelledError

::: opendecree.CancelledError
options:
show_source: false

### UnimplementedError

::: opendecree.UnimplementedError
options:
show_source: false
Loading