From ede946c1b43cf27c276c6357c1cf06de4f37a775 Mon Sep 17 00:00:00 2001 From: gram Date: Tue, 11 Apr 2023 14:01:47 +0200 Subject: [PATCH] add link to the docs --- README.md | 6 ++++-- docs/index.md | 2 ++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5d38417..50a0970 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # pytypest -Type-safe and maintainable fixtures and parametrization for pytest. +Type-safe and maintainable fixtures and parametrization for [pytest](https://github.com/pytest-dev/pytest). Features: + 100% type safe. -+ Great IDE integration, go-todefinition always takes you in the right place. ++ Great IDE integration, go-to-definition always takes you in the right place. + Test parametrization that is redable even with many arguments. + Plug-and-play integration with pytest. + No vendor-lock, you can use only the features you need and don't touch the rest. @@ -39,3 +39,5 @@ def test_user() -> None: ``` Compared to built-in pytest fixtures, these are explicit, type-safe, can accept arguments, support go-to-definition in IDE, and can be used as context managers. And like pytest fixtures, they are cached and can be scoped to the module or the whole session. + +Read more in the **documentation**: [pytypest.orsinium.dev](https://pytypest.orsinium.dev/). diff --git a/docs/index.md b/docs/index.md index 45e0132..c4692b8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,6 +5,8 @@ :end-before: "## Usage" ``` +**Source code:** [github.com/orsinium-labs/pytypest](https://github.com/orsinium-labs/pytypest). + ```{eval-rst} .. toctree:: :maxdepth: 1