From fc5ab0a37609d50a135ac302a9e152d7b6477e46 Mon Sep 17 00:00:00 2001 From: Yasser Tahiri Date: Sun, 22 Dec 2024 23:49:46 +0100 Subject: [PATCH 1/2] :recycle: Update documentation for installation and command usage --- docs/development/contributing.md | 4 +++- docs/index.md | 22 +++++++++++++++++----- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/docs/development/contributing.md b/docs/development/contributing.md index b66c46f2..14c1f626 100644 --- a/docs/development/contributing.md +++ b/docs/development/contributing.md @@ -159,7 +159,7 @@ All the documentation is in Markdown format in the directory `./docs`.
```console -uv pip install requirements-docs.txt +uv sync --group docs --all-extras bash scripts/docs_build.sh ``` @@ -245,6 +245,8 @@ If you want to generate the test report:
```console +$ uv sync --group test --all-extras + $ bash scripts/test.sh ``` diff --git a/docs/index.md b/docs/index.md index a373fec6..f40629aa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,13 +29,25 @@ customizable and adaptable as possible. ## Installation -
+=== "pip" -```console -$ pip install authx +
----> 100% -``` + ```console + $ pip install authx + ``` + +
+ +=== "uv" + +
+ + ```console + $ uv add authx + ``` + +
From be878f5c6251eb843f09c0642ee774249c025bc9 Mon Sep 17 00:00:00 2001 From: Yasser Tahiri Date: Sun, 22 Dec 2024 23:52:33 +0100 Subject: [PATCH 2/2] :recycle: Remove redundant closing div tag in documentation --- docs/index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index f40629aa..4a3c4649 100644 --- a/docs/index.md +++ b/docs/index.md @@ -49,8 +49,6 @@ customizable and adaptable as possible.
-
- ## Features - [x] Support Python 3.8+ & Pydantic 1.7+.