Skip to content

Commit

Permalink
Merge pull request #50 from febus982/fix-docs
Browse files Browse the repository at this point in the history
Fix web docs pagination and add badges
  • Loading branch information
febus982 authored Jan 27, 2024
2 parents 870d121 + 503064c commit b4f2cb5
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 8 deletions.
10 changes: 2 additions & 8 deletions docs/.pages
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
nav:
- Home: index.md
- Bind manager:
- Configuration: manager/config.md
- Models setup: manager/models.md
- Session usage: manager/session.md
- Alembic integration: manager/alembic.md
- Repository:
- Repository usage: repository/usage.md
- Unit of work: repository/uow.md
- Bind manager: manager
- Repository: repository
- Components life cycle: lifecycle.md
- ...
13 changes: 13 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
# SQLAlchemy bind manager
![Static Badge](https://img.shields.io/badge/Python-3.8_%7C_3.9_%7C_3.10_%7C_3.11-blue?logo=python&logoColor=white)
[![Stable Version](https://img.shields.io/pypi/v/sqlalchemy-bind-manager?color=blue)](https://pypi.org/project/sqlalchemy-bind-manager/)
[![stability-beta](https://img.shields.io/badge/stability-beta-33bbff.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta)

[![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)
[![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)
[![Maintainability](https://api.codeclimate.com/v1/badges/0140f7f4e559ae806887/maintainability)](https://codeclimate.com/github/febus982/sqlalchemy-bind-manager/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/0140f7f4e559ae806887/test_coverage)](https://codeclimate.com/github/febus982/sqlalchemy-bind-manager/test_coverage)

[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)

This package provides an easy way to configure and use SQLAlchemy without
depending on frameworks.
Expand Down
6 changes: 6 additions & 0 deletions docs/manager/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
nav:
- Configuration: config.md
- Models setup: models.md
- Session usage: session.md
- Alembic integration: alembic.md
- ...
4 changes: 4 additions & 0 deletions docs/repository/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
nav:
- Repository usage: usage.md
- Unit of work: uow.md
- ...

0 comments on commit b4f2cb5

Please sign in to comment.