diff --git a/README.md b/README.md index 99b1b69..d27aa61 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@
--- -**Documentation**: https://fastapi-utils.davidmontague.xyz +**Documentation**: https://fastapiutils.github.io/fastapi-utils/ **Source Code**: https://github.com/dmontagu/fastapi-utils @@ -53,7 +53,7 @@ It also adds a variety of more basic utilities that are useful across a wide var * **CamelCase Conversions**: Convenience functions for converting strings from `snake_case` to `camelCase` or `PascalCase` and back * **GUID Type**: The provided GUID type makes it easy to use UUIDs as the primary keys for your database tables -See the [docs](https://fastapi-utils.davidmontague.xyz/) for more details and examples. +See the [docs](https://fastapiutils.github.io/fastapi-utils//) for more details and examples. ## Requirements diff --git a/docs/index.md b/docs/index.md index f6de184..b557e63 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,7 +20,7 @@ --- -**Documentation**: https://fastapi-utils.davidmontague.xyz +**Documentation**: https://fastapiutils.github.io/fastapi-utils/ **Source Code**: https://github.com/dmontagu/fastapi-utils @@ -53,7 +53,7 @@ It also adds a variety of more basic utilities that are useful across a wide var * **CamelCase Conversions**: Convenience functions for converting strings from `snake_case` to `camelCase` or `PascalCase` and back * **GUID Type**: The provided GUID type makes it easy to use UUIDs as the primary keys for your database tables -See the [docs](https://https://fastapi-utils.davidmontague.xyz/) for more details and examples. +See the [docs](https://https://fastapiutils.github.io/fastapi-utils//) for more details and examples. ## Requirements diff --git a/mkdocs.yml b/mkdocs.yml index 4998088..083b9f4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,36 +1,36 @@ site_name: FastAPI Utilities site_description: FastAPI utilities -site_url: https://fastapi-utils.davidmontague.xyz/ +site_url: https://fastapiutils.github.io/fastapi-utils// theme: - name: 'material' + name: "material" palette: - primary: 'green' - accent: 'orange' - logo: 'img/icon-white.svg' - favicon: 'img/favicon.png' + primary: "green" + accent: "orange" + logo: "img/icon-white.svg" + favicon: "img/favicon.png" repo_name: dmontagu/fastapi-utils repo_url: https://github.com/dmontagu/fastapi-utils nav: - - FastAPI Utilities: 'index.md' + - FastAPI Utilities: "index.md" - User Guide: - - Class Resource: 'user-guide/class-resource.md' - - Class Based Views: 'user-guide/class-based-views.md' - - Repeated Tasks: 'user-guide/repeated-tasks.md' - - Timing Middleware: 'user-guide/timing-middleware.md' - - SQLAlchemy Sessions: 'user-guide/session.md' - - OpenAPI Spec Simplification: 'user-guide/openapi.md' + - Class Resource: "user-guide/class-resource.md" + - Class Based Views: "user-guide/class-based-views.md" + - Repeated Tasks: "user-guide/repeated-tasks.md" + - Timing Middleware: "user-guide/timing-middleware.md" + - SQLAlchemy Sessions: "user-guide/session.md" + - OpenAPI Spec Simplification: "user-guide/openapi.md" - Other Utilities: - - APIModel: 'user-guide/basics/api-model.md' - - APISettings: 'user-guide/basics/api-settings.md' - - String-Valued Enums: 'user-guide/basics/enums.md' - - CamelCase Conversion: 'user-guide/basics/camelcase.md' - - GUID Type: 'user-guide/basics/guid-type.md' - - Get Help: 'help-fastapi-utils.md' - - Development - Contributing: 'contributing.md' - - Release Notes: 'release-notes.md' + - APIModel: "user-guide/basics/api-model.md" + - APISettings: "user-guide/basics/api-settings.md" + - String-Valued Enums: "user-guide/basics/enums.md" + - CamelCase Conversion: "user-guide/basics/camelcase.md" + - GUID Type: "user-guide/basics/guid-type.md" + - Get Help: "help-fastapi-utils.md" + - Development - Contributing: "contributing.md" + - Release Notes: "release-notes.md" markdown_extensions: - toc: @@ -47,8 +47,8 @@ markdown_extensions: extra: social: - - icon: 'fontawesome/brands/github-alt' - link: 'https://github.com/dmontagu/fastapi-utils' + - icon: "fontawesome/brands/github-alt" + link: "https://github.com/dmontagu/fastapi-utils" extra_css: - - 'css/custom.css' + - "css/custom.css" diff --git a/pyproject.toml b/pyproject.toml index 493d24b..9ba9658 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,9 +5,9 @@ description = "Reusable utilities for FastAPI" license = "MIT" authors = ["Yuval Levi