fixing setup author email and improving docs structure

arthurpaulino · Apr 23, 2019 · 9862315 · 9862315
1 parent de9d180
commit 9862315
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 26 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,4 +5,5 @@ MiraiML Docs
    :maxdepth: 2
 
    user_guide
-   miraiml
+   the_api
+   internal_modules
diff --git a/docs/internal_modules.rst b/docs/internal_modules.rst
@@ -0,0 +1,20 @@
+Internal modules
+================
+
+The documentation related to these modules is meant for developers.
+
+miraiml.core
+------------
+
+.. automodule:: miraiml.core
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+miraiml.util
+------------
+
+.. automodule:: miraiml.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/miraiml.rst → docs/the_api.rst b/docs/miraiml.rst → docs/the_api.rst
@@ -1,5 +1,5 @@
-Package Content
-===============
+The API
+=======
 
 .. automodule:: miraiml
 
@@ -26,22 +26,3 @@ miraiml.Engine
     :members:
     :undoc-members:
     :show-inheritance:
-
-Internal modules
-----------------
-
-miraiml.core
-++++++++++++
-
-.. automodule:: miraiml.core
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-miraiml.util
-++++++++++++
-
-.. automodule:: miraiml.util
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/user_guide.rst b/docs/user_guide.rst
@@ -1,5 +1,5 @@
-MiraiML User Guide
-==================
+User Guide
+==========
 
 Introduction
 ------------

diff --git a/miraiml/__init__.py b/miraiml/__init__.py
@@ -10,7 +10,7 @@
 >>> from miraiml import HyperSearchSpace, Config, Engine
 """
 
-__version__ = '2.0.0'
+__version__ = '2.0.1'
 
 from .main import HyperSearchSpace, Config, Engine
 

diff --git a/setup.py b/setup.py
@@ -10,7 +10,7 @@
     version = VERSION,
     packages = ["miraiml"],
     author = "Arthur Paulino",
-    author_email = "arthurleonardo.ap@gmail.com.com",
+    author_email = "arthurleonardo.ap@gmail.com",
     url = "https://github.com/arthurpaulino/miraiml",
     description = "An asynchronous engine for continuous & autonomous machine\
         learning, built for real-time usage",