From cc612677f1ffbe0c1f60def8b51d778ef44dfc22 Mon Sep 17 00:00:00 2001
From: lukas leufen <l.leufen@fz-juelich.de>
Date: Tue, 25 Aug 2020 16:56:55 +0200
Subject: [PATCH] include always recent version number, get-started is split
into a get-started and customise part
---
docs/_source/_api/{machinelearningtools.rst => mlair.rst} | 6 +++---
docs/_source/conf.py | 6 ++++--
docs/_source/index.rst | 6 ++++--
requirements.txt | 2 ++
4 files changed, 13 insertions(+), 7 deletions(-)
rename docs/_source/_api/{machinelearningtools.rst => mlair.rst} (50%)
diff --git a/docs/_source/_api/machinelearningtools.rst b/docs/_source/_api/mlair.rst
similarity index 50%
rename from docs/_source/_api/machinelearningtools.rst
rename to docs/_source/_api/mlair.rst
index cd6885f5..26166fc3 100644
--- a/docs/_source/_api/machinelearningtools.rst
+++ b/docs/_source/_api/mlair.rst
@@ -1,7 +1,7 @@
-machinelearningtools package
-============================
+MLAir package
+=============
-.. automodule:: src
+.. automodule:: mlair
:members:
:undoc-members:
:show-inheritance:
diff --git a/docs/_source/conf.py b/docs/_source/conf.py
index 573918ee..d4c71e69 100644
--- a/docs/_source/conf.py
+++ b/docs/_source/conf.py
@@ -15,6 +15,8 @@ import sys
sys.path.insert(0, os.path.abspath('../..'))
+import mlair
+
# -- Project information -----------------------------------------------------
project = 'MLAir'
@@ -22,9 +24,9 @@ copyright = '2020, Lukas H Leufen, Felix Kleinert'
author = 'Lukas H Leufen, Felix Kleinert'
# The short X.Y version
-version = 'v0.9.0'
+version = "v" + ".".join(mlair.__version__.split(".")[0:2])
# The full version, including alpha/beta/rc tags
-release = 'v0.9.0'
+release = "v" + mlair.__version__
# -- General configuration ---------------------------------------------------
diff --git a/docs/_source/index.rst b/docs/_source/index.rst
index 341ac58a..89d7e5f7 100644
--- a/docs/_source/index.rst
+++ b/docs/_source/index.rst
@@ -1,16 +1,18 @@
-.. machinelearningtools documentation master file, created by
+.. MLair documentation master file, created by
sphinx-quickstart on Wed Apr 15 14:27:29 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to machinelearningtools's documentation!
+Welcome to MLAir's documentation!
================================================
+
.. toctree::
:maxdepth: 2
:caption: Contents:
get-started
+ customise
api
diff --git a/requirements.txt b/requirements.txt
index 7da29a05..e2d8f5bc 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -65,3 +65,5 @@ wcwidth==0.1.8
Werkzeug==1.0.0
xarray==0.15.0
zipp==3.1.0
+
+setuptools~=49.6.0
\ No newline at end of file
--
GitLab