Skip to content

Commit 503064c

Browse files
committed
Fix web docs pagination and add badges
1 parent 870d121 commit 503064c

File tree

4 files changed

+25
-8
lines changed

4 files changed

+25
-8
lines changed

docs/.pages

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
nav:
22
- Home: index.md
3-
- Bind manager:
4-
- Configuration: manager/config.md
5-
- Models setup: manager/models.md
6-
- Session usage: manager/session.md
7-
- Alembic integration: manager/alembic.md
8-
- Repository:
9-
- Repository usage: repository/usage.md
10-
- Unit of work: repository/uow.md
3+
- Bind manager: manager
4+
- Repository: repository
115
- Components life cycle: lifecycle.md
126
- ...

docs/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
11
# SQLAlchemy bind manager
2+
![Static Badge](https://img.shields.io/badge/Python-3.8_%7C_3.9_%7C_3.10_%7C_3.11-blue?logo=python&logoColor=white)
3+
[![Stable Version](https://img.shields.io/pypi/v/sqlalchemy-bind-manager?color=blue)](https://pypi.org/project/sqlalchemy-bind-manager/)
4+
[![stability-beta](https://img.shields.io/badge/stability-beta-33bbff.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta)
5+
6+
[![Python tests](https://github.com/febus982/sqlalchemy-bind-manager/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/febus982/sqlalchemy-bind-manager/actions/workflows/python-tests.yml)
7+
[![Bandit checks](https://github.com/febus982/sqlalchemy-bind-manager/actions/workflows/python-bandit.yml/badge.svg?branch=main)](https://github.com/febus982/sqlalchemy-bind-manager/actions/workflows/python-bandit.yml)
8+
[![Maintainability](https://api.codeclimate.com/v1/badges/0140f7f4e559ae806887/maintainability)](https://codeclimate.com/github/febus982/sqlalchemy-bind-manager/maintainability)
9+
[![Test Coverage](https://api.codeclimate.com/v1/badges/0140f7f4e559ae806887/test_coverage)](https://codeclimate.com/github/febus982/sqlalchemy-bind-manager/test_coverage)
10+
11+
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
12+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
13+
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
14+
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
215

316
This package provides an easy way to configure and use SQLAlchemy without
417
depending on frameworks.

docs/manager/.pages

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
nav:
2+
- Configuration: config.md
3+
- Models setup: models.md
4+
- Session usage: session.md
5+
- Alembic integration: alembic.md
6+
- ...

docs/repository/.pages

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
nav:
2+
- Repository usage: usage.md
3+
- Unit of work: uow.md
4+
- ...

0 commit comments

Comments
 (0)