diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..9945569
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,16 @@
+# Required
+version: 2
+
+build:
+ os: ubuntu-20.04
+ tools:
+ python: "3.9"
+
+mkdocs:
+ configuration: mkdocs.yml
+
+python:
+ install:
+ - requirements: requirements/docs.txt
+ - method: pip
+ path: .
diff --git a/docs/Makefile b/docs/Makefile
deleted file mode 100644
index d4bb2cb..0000000
--- a/docs/Makefile
+++ /dev/null
@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS ?=
-SPHINXBUILD ?= sphinx-build
-SOURCEDIR = .
-BUILDDIR = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
- @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/conf.py b/docs/conf.py
deleted file mode 100644
index 58822ac..0000000
--- a/docs/conf.py
+++ /dev/null
@@ -1,57 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-import os
-import sys
-from datetime import datetime
-
-
-sys.path.insert(0, os.path.abspath('.'))
-
-
-# -- Project information -----------------------------------------------------
-
-project = 'Python RQL'
-copyright = f'{datetime.now().year}, CloudBlue LLC'
-author = 'CloudBlue'
-
-
-# -- General configuration ---------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
- 'sphinx.ext.autodoc',
- 'sphinx.ext.autosectionlabel',
-]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'sphinx_rtd_theme'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
diff --git a/docs/css/custom.css b/docs/css/custom.css
new file mode 100644
index 0000000..c48fc77
--- /dev/null
+++ b/docs/css/custom.css
@@ -0,0 +1,16 @@
+:root>* {
+ --md-primary-fg-color: #1565c0;
+ --md-primary-fg-color--light: #1565c0;
+ --md-primary-fg-color--dark: #1565c0;
+}
+
+div.autodoc-docstring {
+ padding-left: 20px;
+ margin-bottom: 30px;
+ border-left: 5px solid rgba(230, 230, 230);
+}
+
+div.autodoc-members {
+ padding-left: 20px;
+ margin-bottom: 15px;
+}
diff --git a/docs/guide.md b/docs/guide.md
new file mode 100644
index 0000000..5c0ba19
--- /dev/null
+++ b/docs/guide.md
@@ -0,0 +1,87 @@
+# Getting started
+
+## Install
+
+*Python RQL* is a small python package that can be installed from the
+[pypi.org](https://pypi.org/project/lib-rql/) repository.
+
+``` sh
+$ pip install lib-rql
+```
+
+# First steps with Python RQL
+
+Python RQL allows you to filter a list of python dictionary using RQL.
+
+First of all you have define your filters. To do so you have to create a
+class that inherits from `FilterClass` and declare your filters like in the following example:
+
+``` py3
+from py_rql.constants import FilterTypes
+from py_rql.filter_cls import FilterClass
+
+
+class BookFilter(FilterClass):
+ FILTERS = [
+ {
+ 'filter': 'title',
+ },
+ {
+ 'filter': 'author.name',
+ },
+ {
+ 'filter': 'status',
+ },
+ {
+ 'filter': 'pages',
+ 'type': FilterTypes.INT,
+ },
+ {
+ 'filter': 'featured',
+ 'type': FilterTypes.BOOLEAN,
+ },
+ {
+ 'filter': 'publish_date',
+ 'type': FilterTypes.DATETIME,
+ },
+ ]
+```
+
+Then you can use your BookFilter like in the following example:
+
+``` py3
+filters = BookFilter()
+
+query = 'eq(title,Practical Modern JavaScript)'
+results = list(filters.filter(query, DATA))
+
+print(results)
+
+query = 'or(eq(pages,472),lt(pages,400))'
+results = list(filters.filter(query, DATA))
+
+print(results)
+```
+
+See the examples folder in the project root for a demo program.
+
+# Customize filter lookups
+
+You can explicitly declare the lookups you want to support for a
+specific filter. For example if you want to just support the
+`eq` and `ne` lookup for a string filter you can
+do that like in the following example:
+
+``` py3
+from py_rql.constants import FilterLookups, FilterTypes
+from py_rql.filter_cls import FilterClass
+
+
+class BookFilter(FilterClass):
+ FILTERS = [
+ {
+ 'filter': 'title',
+ 'lookups': {FilterLookups.EQ, FilterLookups.NE}
+ },
+ ]
+```
diff --git a/docs/guide.rst b/docs/guide.rst
deleted file mode 100644
index 3dbfd93..0000000
--- a/docs/guide.rst
+++ /dev/null
@@ -1,104 +0,0 @@
-User guide
-==========
-
-
-Getting started
----------------
-
-
-Install
-^^^^^^^
-
-*Python RQL* is a small python package that can be installed
-from the `pypi.org `_ repository.
-
-
-.. code-block:: sh
-
- $ pip install lib-rql
-
-
-
-First steps with Python RQL
----------------------------
-
-Python RQL allows you to filter a list of python dictionary using RQL.
-
-First of all you have define your filters. To do so you have to create a class that
-inherits from :class:`~py_rql.filter_cls.FilterClass` and declare your filters like in the following example:
-
-.. code-block:: python
-
- from py_rql.constants import FilterTypes
- from py_rql.filter_cls import FilterClass
-
-
- class BookFilter(FilterClass):
- FILTERS = [
- {
- 'filter': 'title',
- },
- {
- 'filter': 'author.name',
- },
- {
- 'filter': 'status',
- },
- {
- 'filter': 'pages',
- 'type': FilterTypes.INT,
- },
- {
- 'filter': 'featured',
- 'type': FilterTypes.BOOLEAN,
- },
- {
- 'filter': 'publish_date',
- 'type': FilterTypes.DATETIME,
- },
- ]
-
-
-
-Then you can use your BookFilter like in the following example:
-
-.. code-block:: python
-
- filters = BookFilter()
-
- query = 'eq(title,Practical Modern JavaScript)'
- results = list(filters.filter(query, DATA))
-
- print(results)
-
- query = 'or(eq(pages,472),lt(pages,400))'
- results = list(filters.filter(query, DATA))
-
- print(results)
-
-
-See the examples folder in the project root for a demo program.
-
-
-Customize filter lookups
-------------------------
-
-You can explicitly declare the lookups you want to support for a specific filter.
-For example if you want to just support the `eq` and `ne` lookup for a string filter you can do
-that like in the following example:
-
-
-.. code-block:: python
-
- from py_rql.constants import FilterLookups, FilterTypes
- from py_rql.filter_cls import FilterClass
-
-
- class BookFilter(FilterClass):
- FILTERS = [
- {
- 'filter': 'title',
- 'lookups': {FilterLookups.EQ, FilterLookups.NE}
- },
- ]
-
diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico
new file mode 100644
index 0000000..fc31477
--- /dev/null
+++ b/docs/images/favicon.ico
@@ -0,0 +1,12 @@
+
Unsupported browser
This portal is not supported by the web browser you're currently using
Please use one of the following browsers: Chrome 58+, Firefox 55+, Safari 10+, Opera 47+ or Microsoft Edge 16+