Merge branch 'release/0.2.0'

.env.general.template

@@ -0,0 +1,17 @@
+# Base configurations
+PROJECT_NAME=myautoml
+
+## Input
+DIR_DATA=${HOME}/data
+
+## Temporary files
+DIR_TEMP=${HOME}/tmp/${PROJECT_NAME}
+DIR_CACHE=${DIR_TEMP}/cache
+
+## Output
+DIR_OUTPUT=${HOME}/output/${PROJECT_NAME}
+DIR_LOGS=${DIR_OUTPUT}/logs
+
+## MLflow
+MLFLOW_TRACKING_URI=http://localhost:5000
+DEFAULT_ARTIFACT_ROOT=${HOME}/mlflow/artifact-root

.readthedocs.yml

@@ -0,0 +1,24 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.8
+  install:
+    - requirements: requirements/docs.txt

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     = source
+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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+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/source/_static/css/base.css

@@ -0,0 +1,36 @@
+/* Getting started index page */
+
+.intro-card {
+  background: #fff;
+  border-radius: 0;
+  padding: 30px 10px 10px 10px;
+  margin: 10px 0px;
+}
+
+.intro-card .card-text {
+  margin: 20px 0px;
+  /*min-height: 150px; */
+}
+
+.custom-button {
+  background-color: #dcdcdc;
+  border: none;
+  color: #484848;
+  text-align: center;
+  text-decoration: none;
+  display: inline-block;
+  font-size: 0.9rem;
+  border-radius: 0.5rem;
+  max-width: 220px;
+  padding: 0.5rem 0rem;
+}
+
+.custom-button a {
+  color: #484848;
+}
+
+.custom-button p {
+  margin-top: 0;
+  margin-bottom: 0rem;
+  color: #484848;
+}

docs/source/_static/css/getting_started.css

@@ -0,0 +1,251 @@
+/* Getting started pages */
+
+/* data intro */
+.gs-data {
+  font-size: 0.9rem;
+}
+
+.gs-data-title {
+  align-items: center;
+  font-size: 0.9rem;
+}
+
+.gs-data-title .badge {
+  margin: 10px;
+  padding: 5px;
+}
+
+.gs-data .badge {
+  cursor: pointer;
+  padding: 10px;
+  border: none;
+  text-align: left;
+  outline: none;
+  font-size: 12px;
+}
+
+.gs-data .btn {
+ background-color: grey;
+ border: none;
+}
+
+/* note/alert properties */
+
+.alert-heading {
+  font-size: 1.2rem;
+}
+
+/* callout properties */
+.gs-callout {
+  padding: 20px;
+  margin: 20px 0;
+  border: 1px solid #eee;
+  border-left-width: 5px;
+  border-radius: 3px;
+}
+.gs-callout h4 {
+  margin-top: 0;
+  margin-bottom: 5px;
+}
+.gs-callout p:last-child {
+  margin-bottom: 0;
+}
+.gs-callout code {
+  border-radius: 3px;
+}
+.gs-callout+.gs-callout {
+  margin-top: -5px;
+}
+.gs-callout-remember {
+  border-left-color: #f0ad4e;
+  align-items: center;
+  font-size: 1.2rem;
+}
+.gs-callout-remember h4 {
+  color: #f0ad4e;
+}
+
+/* reference to user guide */
+.gs-torefguide {
+  align-items: center;
+  font-size: 0.9rem;
+}
+
+.gs-torefguide .badge {
+  background-color: #130654;
+  margin: 10px 10px 10px 0px;
+  padding: 5px;
+}
+
+.gs-torefguide a {
+  margin-left: 5px;
+  color: #130654;
+  border-bottom: 1px solid #FFCA00f3;
+  box-shadow: 0px -10px 0px #FFCA00f3 inset;
+}
+
+.gs-torefguide p {
+  margin-top: 1rem;
+}
+
+.gs-torefguide a:hover {
+  margin-left: 5px;
+  color: grey;
+  text-decoration: none;
+  border-bottom: 1px solid #b2ff80f3;
+  box-shadow: 0px -10px 0px #b2ff80f3 inset;
+}
+
+/* question-task environment */
+
+ul.task-bullet, ol.custom-bullet{
+  list-style:none;
+  padding-left: 0;
+  margin-top: 2em;
+}
+
+ul.task-bullet > li:before {
+    content:"";
+    height:2em;
+    width:2em;
+    display:block;
+    float:left;
+    margin-left:-2em;
+    background-position:center;
+    background-repeat:no-repeat;
+    background-color: #130654;
+    border-radius: 50%;
+    background-size:100%;
+    background-image:url('../question_mark_noback.svg');
+  }
+
+ul.task-bullet > li {
+  border-left: 1px solid #130654;
+  padding-left:1em;
+}
+
+ul.task-bullet > li > p:first-child {
+  font-size: 1.1rem;
+  padding-left: 0.75rem;
+}
+
+/* Getting started index page */
+
+.intro-card {
+  background:#FFF;
+  border-radius:0;
+  padding: 30px 10px 10px 10px;
+  margin: 10px 0px;
+}
+
+.intro-card .card-text {
+  margin:20px 0px;
+  /*min-height: 150px; */
+}
+
+.intro-card .card-img-top {
+  margin: 10px;
+}
+
+.install-block {
+  padding-bottom: 30px;
+}
+
+.install-card .card-header {
+  border: none;
+  background-color:white;
+  color: #150458;
+  font-size: 1.1rem;
+  font-weight: bold;
+  padding: 1rem 1rem 0rem 1rem;
+}
+
+.install-card .card-footer {
+  border: none;
+  background-color:white;
+}
+
+.install-card pre {
+  margin: 0 1em 1em 1em;
+}
+
+.custom-button {
+  background-color:#DCDCDC;
+  border: none;
+  color: #484848;
+  text-align: center;
+  text-decoration: none;
+  display: inline-block;
+  font-size: 0.9rem;
+  border-radius: 0.5rem;
+  max-width: 120px;
+  padding: 0.5rem 0rem;
+}
+
+.custom-button a {
+  color: #484848;
+}
+
+.custom-button p {
+  margin-top: 0;
+  margin-bottom: 0rem;
+  color: #484848;
+}
+
+/* intro to tutorial collapsed cards */
+
+.tutorial-accordion {
+  margin-top: 20px;
+  margin-bottom: 20px;
+}
+
+.tutorial-card .card-header.card-link .btn {
+  margin-right: 12px;
+}
+
+.tutorial-card .card-header.card-link .btn:after {
+  content: "-";
+}
+
+.tutorial-card .card-header.card-link.collapsed .btn:after {
+  content: "+";
+}
+
+.tutorial-card-header-1 {
+  justify-content: space-between;
+  align-items: center;
+}
+
+.tutorial-card-header-2 {
+  justify-content: flex-start;
+  align-items: center;
+  font-size: 1.3rem;
+}
+
+.tutorial-card .card-header {
+  cursor: pointer;
+  background-color: white;
+}
+
+.tutorial-card .card-body {
+  background-color: #F0F0F0;
+}
+
+.tutorial-card .badge {
+  background-color: #130654;
+  margin: 10px 10px 10px 10px;
+  padding: 5px;
+}
+
+.tutorial-card .gs-badge-link p {
+  margin: 0px;
+}
+
+.tutorial-card .gs-badge-link a {
+  color: white;
+  text-decoration: none;
+}
+
+.tutorial-card .badge:hover {
+  background-color: grey;
+}