Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Update documentation for installation and command usage #718

Merged
merged 2 commits into from
Dec 22, 2024
Merged

📝 Update documentation for installation and command usage #718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc5ab0a
:recycle: Update documentation for installation and command usage
yezz123 Dec 22, 2024
be878f5
:recycle: Remove redundant closing div tag in documentation
yezz123 Dec 22, 2024
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
4 changes: 3 additions & 1 deletion docs/development/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ All the documentation is in Markdown format in the directory `./docs`.
<div class="termy">

```console
uv pip install requirements-docs.txt
uv sync --group docs --all-extras

bash scripts/docs_build.sh
```
Expand Down Expand Up @@ -245,6 +245,8 @@ If you want to generate the test report:
<div class="termy">

```console
$ uv sync --group test --all-extras

$ bash scripts/test.sh
```

Expand Down
22 changes: 16 additions & 6 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,25 @@ customizable and adaptable as possible.

## Installation

<div class="termy">
=== "pip"

```console
$ pip install authx
<div class="termy">

---> 100%
```
```console
$ pip install authx
```

</div>

=== "uv"

<div class="termy">

```console
$ uv add authx
```

</div>
</div>

## Features

Expand Down
Loading