outbrain · SkBlaz · Sep 13, 2023 · Sep 12, 2023 · Sep 12, 2023
diff --git a/DOCS.md b/DOCS.md
@@ -0,0 +1,12 @@
+
+    ░█████╗░██╗░░░██╗████████╗██████╗░░█████╗░███╗░░██╗██╗░░██╗
+    ██╔══██╗██║░░░██║╚══██╔══╝██╔══██╗██╔══██╗████╗░██║██║░██╔╝
+    ██║░░██║██║░░░██║░░░██║░░░██████╔╝███████║██╔██╗██║█████═╝░
+    ██║░░██║██║░░░██║░░░██║░░░██╔══██╗██╔══██║██║╚████║██╔═██╗░
+    ╚█████╔╝╚██████╔╝░░░██║░░░██║░░██║██║░░██║██║░╚███║██║░╚██╗
+    ░╚════╝░░╚═════╝░░░░╚═╝░░░╚═╝░░╚═╝╚═╝░░╚═╝╚═╝░░╚══╝╚═╝░░╚═╝
+
+
+# Welcome to OutRank's documentation!
+
+All functions/methods can be searched-for (search bar on the left).
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./outrank.html"/>
+</head>
+</html>
diff --git a/docs/outrank.html b/docs/outrank.html
diff --git a/docs/outrank/algorithms.html b/docs/outrank/algorithms.html
diff --git a/docs/outrank/algorithms/feature_ranking.html b/docs/outrank/algorithms/feature_ranking.html
diff --git a/docs/outrank/algorithms/feature_ranking/ranking_mi_numba.html b/docs/outrank/algorithms/feature_ranking/ranking_mi_numba.html
diff --git a/docs/outrank/algorithms/importance_estimator.html b/docs/outrank/algorithms/importance_estimator.html
diff --git a/docs/outrank/algorithms/sketches.html b/docs/outrank/algorithms/sketches.html
diff --git a/docs/outrank/algorithms/sketches/counting_ultiloglog.html b/docs/outrank/algorithms/sketches/counting_ultiloglog.html
diff --git a/docs/outrank/algorithms/synthetic_data_generators.html b/docs/outrank/algorithms/synthetic_data_generators.html
diff --git a/docs/outrank/algorithms/synthetic_data_generators/generator_naive.html b/docs/outrank/algorithms/synthetic_data_generators/generator_naive.html
diff --git a/docs/outrank/core_ranking.html b/docs/outrank/core_ranking.html
diff --git a/docs/outrank/core_selftest.html b/docs/outrank/core_selftest.html
diff --git a/docs/outrank/core_utils.html b/docs/outrank/core_utils.html
diff --git a/docs/outrank/feature_transformations.html b/docs/outrank/feature_transformations.html
diff --git a/docs/outrank/feature_transformations/feature_transformer_vault.html b/docs/outrank/feature_transformations/feature_transformer_vault.html
diff --git a/docs/outrank/feature_transformations/feature_transformer_vault/default_transformers.html b/docs/outrank/feature_transformations/feature_transformer_vault/default_transformers.html
diff --git a/docs/outrank/feature_transformations/feature_transformer_vault/fw_transformers.html b/docs/outrank/feature_transformations/feature_transformer_vault/fw_transformers.html
diff --git a/docs/outrank/feature_transformations/ranking_transformers.html b/docs/outrank/feature_transformations/ranking_transformers.html
diff --git a/docs/outrank/task_generators.html b/docs/outrank/task_generators.html
diff --git a/docs/outrank/task_ranking.html b/docs/outrank/task_ranking.html
diff --git a/docs/outrank/task_selftest.html b/docs/outrank/task_selftest.html
diff --git a/docs/outrank/task_summary.html b/docs/outrank/task_summary.html
diff --git a/docs/outrank/task_visualization.html b/docs/outrank/task_visualization.html
diff --git a/docs/outrank/visualizations.html b/docs/outrank/visualizations.html
diff --git a/docs/outrank/visualizations/ranking_visualization.html b/docs/outrank/visualizations/ranking_visualization.html
diff --git a/docs/search.js b/docs/search.js
diff --git a/outrank/__init__.py b/outrank/__init__.py
@@ -1,3 +1,6 @@
+"""
+.. include:: ../DOCS.md
+"""
 from __future__ import annotations
 
 import logging

diff --git a/run_build_docs.sh b/run_build_docs.sh
@@ -0,0 +1 @@
+rm -rf docs; pdoc ./outrank -o docs;
diff --git a/setup.py b/setup.py
@@ -3,7 +3,7 @@
 import os
 
 import setuptools
-# test
+
 
 def _parse_requirements(file):
     required_packages = []