From 686a1235cccbb9b195b8fcbea76e4c1e1fc62272 Mon Sep 17 00:00:00 2001
From: lukas leufen <l.leufen@fz-juelich.de>
Date: Tue, 21 Apr 2020 13:37:01 +0200
Subject: [PATCH] add docs first setup

---
 .gitignore                                 |  6 +++++-
 docs/_source/_api/machinelearningtools.rst | 10 ++++++++++
 docs/_source/api.rst                       |  9 +++++++++
 docs/_source/get-started.rst               | 16 ++++++++++++++++
 4 files changed, 40 insertions(+), 1 deletion(-)
 create mode 100644 docs/_source/_api/machinelearningtools.rst
 create mode 100644 docs/_source/api.rst
 create mode 100644 docs/_source/get-started.rst

diff --git a/.gitignore b/.gitignore
index 222931f8..01ddc973 100644
--- a/.gitignore
+++ b/.gitignore
@@ -63,4 +63,8 @@ report.html
 
 # secret variables #
 ####################
-/src/join_settings.py
\ No newline at end of file
+/src/join_settings.py
+
+# ignore locally build documentation #
+######################################
+/docs/_build
diff --git a/docs/_source/_api/machinelearningtools.rst b/docs/_source/_api/machinelearningtools.rst
new file mode 100644
index 00000000..cd6885f5
--- /dev/null
+++ b/docs/_source/_api/machinelearningtools.rst
@@ -0,0 +1,10 @@
+machinelearningtools package
+============================
+
+.. automodule:: src
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
diff --git a/docs/_source/api.rst b/docs/_source/api.rst
new file mode 100644
index 00000000..63db2308
--- /dev/null
+++ b/docs/_source/api.rst
@@ -0,0 +1,9 @@
+Package Reference
+=================
+
+Information on specific functions, classes, and methods.
+
+.. toctree::
+   :glob:
+
+   _api/*
\ No newline at end of file
diff --git a/docs/_source/get-started.rst b/docs/_source/get-started.rst
new file mode 100644
index 00000000..e5a82fdc
--- /dev/null
+++ b/docs/_source/get-started.rst
@@ -0,0 +1,16 @@
+Get started with MachineLearningTools
+=====================================
+
+<what is machinelearningtools?>
+
+MLT Module and Funtion Documentation
+------------------------------------
+
+Install MachineLearningTools
+----------------------------
+
+Dependencies
+~~~~~~~~~~~~
+
+Data
+~~~~
-- 
GitLab