doc: Include link to the documentation (#134)

README.md

@@ -1,31 +1,35 @@
 <img src="https://repository-images.githubusercontent.com/735134836/df6752b8-38fa-4550-968e-cd2eda4adb37" alt="meatie">
 
-[![GitHub Test Badge][1]][2] [![codecov.io][3]][4] [![pypi.org][5]][6] [![versions][7]][8]
-[![downloads][9]][10] [![License][11]][12]
+[![GitHub Test Badge][1]][2] [![Docs][3]][4] [![codecov.io][5]][6] [![pypi.org][7]][8] [![versions][9]][10]
+[![downloads][11]][12] [![License][13]][14]
 
 [1]: https://github.com/pmateusz/meatie/actions/workflows/ci.yaml/badge.svg "GitHub CI Badge"
 
 [2]: https://github.com/pmateusz/meatie/actions/workflows/ci.yaml "GitHub Actions Page"
 
-[3]: https://codecov.io/gh/pmateusz/meatie/branch/master/graph/badge.svg?branch=master "Coverage Badge"
+[3]: https://readthedocs.org/projects/meatie/badge/?version=latest "Docs Latest Version Badge"
 
-[4]: https://codecov.io/gh/pmateusz/meatie?branch=master "Codecov site"
+[4]: https://meatie.readthedocs.io/
 
-[5]: https://img.shields.io/pypi/v/meatie.svg "Pypi Latest Version Badge"
+[5]: https://codecov.io/gh/pmateusz/meatie/branch/master/graph/badge.svg?branch=master "Coverage Badge"
 
-[6]: https://pypi.python.org/pypi/meatie "Pypi site"
+[6]: https://codecov.io/gh/pmateusz/meatie?branch=master "Codecov site"
 
-[7]:https://img.shields.io/pypi/pyversions/meatie.svg
+[7]: https://img.shields.io/pypi/v/meatie.svg "Pypi Latest Version Badge"
 
-[8]: https://github.com/pmateusz/meatie
+[8]: https://pypi.python.org/pypi/meatie "Pypi site"
 
-[9]: https://static.pepy.tech/badge/meatie
+[9]:https://img.shields.io/pypi/pyversions/meatie.svg
 
-[10]: https://pepy.tech/project/meatie
+[10]: https://github.com/pmateusz/meatie
 
-[11]: https://img.shields.io/github/license/pmateusz/meatie "License Badge"
+[11]: https://static.pepy.tech/badge/meatie
 
-[12]: https://opensource.org/license/bsd-3-clause "License"
+[12]: https://pepy.tech/project/meatie
+
+[13]: https://img.shields.io/github/license/pmateusz/meatie "License Badge"
+
+[14]: https://opensource.org/license/bsd-3-clause "License"
 
 Meatie is a Python library that simplifies the implementation of REST API clients. The library generates code for
 calling REST endpoints based on method signatures annotated with type hints. Meatie takes care of mechanics related to
@@ -73,6 +77,12 @@ Do you use a different HTTP client library in your project? See the example adap
 `requests`](./tests/examples/requests/tutorial/test_basics.py) and [
 `httpx`](./tests/examples/httpx/tutorial/test_basics.py).
 
+## Documentation
+
+https://meatie.readthedocs.io/
+
+## Features
+
 ### Caching
 
 Cache result for a given TTL.

docs/index.md

@@ -1,32 +1,35 @@
 <img src="https://repository-images.githubusercontent.com/735134836/df6752b8-38fa-4550-968e-cd2eda4adb37" alt="meatie">
 
-[![GitHub Test Badge][1]][2] [![codecov.io][3]][4] [![pypi.org][5]][6] [![versions][7]][8]
-[![downloads][9]][10] [![License][11]][12]
+[![GitHub Test Badge][1]][2] [![Docs][3]][4] [![codecov.io][5]][6] [![pypi.org][7]][8] [![versions][9]][10]
+[![downloads][11]][12] [![License][13]][14]
 
 [1]: https://github.com/pmateusz/meatie/actions/workflows/ci.yaml/badge.svg "GitHub CI Badge"
 
 [2]: https://github.com/pmateusz/meatie/actions/workflows/ci.yaml "GitHub Actions Page"
 
-[3]: https://codecov.io/gh/pmateusz/meatie/branch/master/graph/badge.svg?branch=master "Coverage Badge"
+[3]: https://readthedocs.org/projects/meatie/badge/?version=latest "Docs Latest Version Badge"
 
-[4]: https://codecov.io/gh/pmateusz/meatie?branch=master "Codecov site"
+[4]: https://meatie.readthedocs.io/
 
-[5]: https://img.shields.io/pypi/v/meatie.svg "Pypi Latest Version Badge"
+[5]: https://codecov.io/gh/pmateusz/meatie/branch/master/graph/badge.svg?branch=master "Coverage Badge"
 
-[6]: https://pypi.python.org/pypi/meatie "Pypi site"
+[6]: https://codecov.io/gh/pmateusz/meatie?branch=master "Codecov site"
 
-[7]:https://img.shields.io/pypi/pyversions/meatie.svg
+[7]: https://img.shields.io/pypi/v/meatie.svg "Pypi Latest Version Badge"
 
-[8]: https://github.com/pmateusz/meatie
+[8]: https://pypi.python.org/pypi/meatie "Pypi site"
 
-[9]: https://static.pepy.tech/badge/meatie
+[9]:https://img.shields.io/pypi/pyversions/meatie.svg
 
-[10]: https://pepy.tech/project/meatie
+[10]: https://github.com/pmateusz/meatie
 
-[11]: https://img.shields.io/github/license/pmateusz/meatie "License Badge"
+[11]: https://static.pepy.tech/badge/meatie
 
-[12]: https://opensource.org/license/bsd-3-clause "License"
+[12]: https://pepy.tech/project/meatie
 
+[13]: https://img.shields.io/github/license/pmateusz/meatie "License Badge"
+
+[14]: https://opensource.org/license/bsd-3-clause "License"
 
 Meatie is a Python library that simplifies the implementation of REST API clients. The library generates code for
 calling REST endpoints based on method signatures annotated with type hints. Meatie takes care of mechanics related to

mkdocs.yml

@@ -17,11 +17,3 @@ plugins:
         python:
           options:
             docstring_style: google
-#            show_root_heading: true
-#            members_order: source
-#            annotations_path: brief
-#            separate_signature: true
-#            modernize_annotations: true
-#            show_signature: true
-#            show_signature_annotations: true
-#            line_length: 60

src/meatie/option/retry_option.py

@@ -22,10 +22,6 @@
 
 __all__ = ["RetryOption"]
 
-"""
-
-"""
-
 
 class RetryOption:
     """Configure the strategy for retrying the endpoint calls that failed."""