chore(docs): setup automatic documentation

docs/Makefile

@@ -0,0 +1,20 @@
+# 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)

docs/_static/css/custom.css

@@ -0,0 +1,4 @@
+.wy-side-nav-search {
+    background-color: #2980b9;
+    color: #fcfcfc;
+}

docs/bias_fairness.rst

@@ -0,0 +1,8 @@
+..
+Bias & Fairness
+=========================================
+
+.. automodule:: ydata_quality.bias_fairness
+   :members:
+   :noindex:
+

docs/conf.py

@@ -0,0 +1,63 @@
+# 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
+sys.path.insert(0, os.path.abspath('./src/ydata-quality'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'ydata-quality'
+copyright = '2021, YData'
+author = 'YData'
+
+
+# -- 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.coverage', 'sphinx.ext.napoleon']
+
+# 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']
+
+html_css_files = [
+    'css/custom.css',
+]
+
+# -- Napoleon configuration ---------------------------------------------------
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+
+
+# -- YData configuration ------------------------------------------------------
+html_logo = 'ydata_logo.png'

docs/data_expectations.rst

@@ -0,0 +1,8 @@
+..
+Data Expectations
+=========================================
+
+.. automodule:: ydata_quality.data_expectations
+   :members:
+   :noindex:
+

docs/data_quality.rst

@@ -0,0 +1,7 @@
+..
+Data Quality
+=========================================
+
+.. automodule:: ydata_quality.core.data_quality
+   :members:
+   :noindex:

docs/drift.rst

@@ -0,0 +1,8 @@
+..
+Drift Analysis
+=========================================
+
+.. automodule:: ydata_quality.drift
+   :members:
+   :noindex:
+

docs/duplicates.rst

@@ -0,0 +1,8 @@
+..
+Duplicates
+=========================================
+
+.. automodule:: ydata_quality.duplicates
+   :members:
+   :noindex:
+

docs/index.rst

@@ -0,0 +1,23 @@
+.. ydata-quality documentation master file, created by
+   sphinx-quickstart on Wed Sep  8 23:46:14 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ydata-quality's documentation!
+=========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Core:
+
+   data_quality
+   bias_fairness
+   data_expectations
+   drift
+   duplicates
+   labelling
+   missings
+   valued_missing_values
+
+
+

docs/labelling.rst

@@ -0,0 +1,14 @@
+..
+Labelling
+=========================================
+
+.. automodule:: ydata_quality.labelling
+   :members:
+   :noindex:
+
+.. autoclass:: ydata_quality.labelling.engine.CategoricalLabelInspector
+   :members:
+
+.. autoclass:: ydata_quality.labelling.engine.NumericalLabelInspector
+   :members:
+

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/missings.rst

@@ -0,0 +1,8 @@
+..
+Missings
+=========================================
+
+.. automodule:: ydata_quality.missings
+   :members:
+   :noindex:
+

docs/valued_missing_values.rst

@@ -0,0 +1,8 @@
+..
+Valued Missing Values
+=========================================
+
+.. automodule:: ydata_quality.valued_missing_values
+   :members:
+   :noindex:
+

docs/warnings.rst

@@ -0,0 +1,30 @@
+========
+Warnings
+========
+
+Structure
+---------
+A QualityWarning contains all the necessary data required for a Data Scientist to understand and assess the impact of a given data quality issue found during the data quality evaluation.
+
+A QualityWarning is composed by:
+    * Category: name of the main test suite (e.g. Duplicates, Bias&Fairness)
+    * Test: name of the individual test (e.g. Exact Duplicates, Performance Bias)
+    * Description: long-text description of the data quality details
+    * Priority: expected impact of the data quality warning
+    * Data: sample of data that showcases the data quality warning
+
+Priorities
+----------
+The Priority aims to provide a quick and intuitive level of severity of a QualityWarning.
+
+========    ============
+Priority    Description
+========    ============
+P0          Blocker. Critical issues that block using the dataset.
+P1          High. Heavy impact expected on downstream application.
+P2          Medium. Allows usage but may block human-intelligible insights.
+P3          Low. Minor impact, aesthetic. No impact on downstream application.
+========    ============
+
+Technically, a Priority is implemented as an OrderedEnum so that we can apply comparison operators (<, <=, >, >=). More details on OrderedEnum are available in the utils sub-package.
+

requirements-dev.txt

@@ -1,5 +1,6 @@
 isort
 pylint
 pytest
-sphinx
+sphinx==4.1.2
+sphinx_rtd_theme
 myst-parser