From 0b0827793c03a4140d9e995993e9b0e903dfe481 Mon Sep 17 00:00:00 2001
From: Darigov Research <30328618+darigovresearch@users.noreply.github.com>
Date: Sun, 4 Dec 2022 10:58:05 +0000
Subject: [PATCH] docs: Adds docs section to readme

Would resolve https://github.com/scikit-learn-contrib/scikit-learn-extra/issues/152 if merged
---
 README.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.rst b/README.rst
index be0ee02c..124b7739 100644
--- a/README.rst
+++ b/README.rst
@@ -24,6 +24,11 @@ scikit-learn-extra - A set of useful tools compatible with scikit-learn
 
 scikit-learn-extra is a Python module for machine learning that extends scikit-learn. It includes algorithms that are useful but do not satisfy the scikit-learn `inclusion criteria <https://scikit-learn.org/stable/faq.html#what-are-the-inclusion-criteria-for-new-algorithms>`_, for instance due to their novelty or lower citation number.
 
+Documentation
+-------------
+
+A full user guides and examples can be found on our `documentation site <https://scikit-learn-extra.readthedocs.io/en/stable/index.html>`_.
+
 Installation
 ------------