Skip to content
Closed
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
7 changes: 4 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,10 @@ check-test-coverage:
@pyenv exec poetry run pytest -vv --cov=$(CODE_DIR) --cov-report=term-missing

generate-docs:
@pyenv exec poetry run python -m pdoc --force --html ${CODE_DIR} -o docs
@mv docs/dynamicio/* docs
@rm -rf docs/dynamicio
@pyenv exec poetry run mkdocs build --strict

serve-docs:
@pyenv exec poetry run mkdocs serve
Comment thread
Christos-Hadjinikolis marked this conversation as resolved.

build-locally:
@pyenv exec poetry build
Expand Down
51 changes: 51 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# API Reference

Auto-generated API documentation for the `dynamicio` package, rendered by
[`mkdocstrings`](https://mkdocstrings.github.io/) directly from Python
docstrings.

## `dynamicio.core`

::: dynamicio.core

## `dynamicio.config`

::: dynamicio.config.io_config

## `dynamicio.mixins`

### S3

::: dynamicio.mixins.with_s3

### Postgres

::: dynamicio.mixins.with_postgres

### Athena

::: dynamicio.mixins.with_athena

### Kafka

::: dynamicio.mixins.with_kafka

### Local filesystem

::: dynamicio.mixins.with_local

### Utilities

::: dynamicio.mixins.utils

## Validation

::: dynamicio.validations

## Errors

::: dynamicio.errors
Comment thread
Christos-Hadjinikolis marked this conversation as resolved.

## CLI

::: dynamicio.cli
332 changes: 0 additions & 332 deletions docs/cli.html

This file was deleted.

80 changes: 0 additions & 80 deletions docs/config/index.html

This file was deleted.

Loading
Loading