Merge pull request #14 from ilcardella/add-docs

Added documentation
ilcardella · Jan 26, 2019 · 50b2100 · 50b2100
2 parents da85142 + 398f801
commit 50b2100
Show file tree

Hide file tree

Showing 7 changed files with 162 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # TradingMate
-[![Build Status](https://travis-ci.com/ilcardella/TradingMate.svg?branch=master)](https://travis-ci.com/ilcardella/TradingMate)
+[![Build Status](https://travis-ci.com/ilcardella/TradingMate.svg?branch=master)](https://travis-ci.com/ilcardella/TradingMate) [![Documentation Status](https://readthedocs.org/projects/tradingmate/badge/?version=latest)](https://tradingmate.readthedocs.io/en/latest/?badge=latest)
 
 TradingMate is a portfolio manager for stocks traders. It lets you record all
 your trades with a simple and basic interface, showing the current status of

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,20 +1,21 @@
-.. TradingMate documentation master file, created by
-   sphinx-quickstart on Sat Jan 26 18:08:05 2019.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+TradingMate's documentation
+===========================
 
-Welcome to TradingMate's documentation!
-=======================================
+Introduction
+^^^^^^^^^^^^
+
+TradingMate is an autonomous trading system that uses customised strategies to
+trade in the London Stock Exchange market.
+This documentation provides an overview of the system, explaining how to create
+new trading strategies and how to integrate them with TradingMate.
+Explore the next sections for a detailed documentation of each module too.
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
-
-
+   :numbered:
 
-Indices and tables
-==================
+   source/system.rst
+   source/modules.rst
+   source/changelog.rst
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. mdinclude:: ../README.md
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -0,0 +1 @@
+.. mdinclude:: ../../CHANGELOG.md
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -0,0 +1,129 @@
+Modules
+=======
+
+Each section of this document provides the source code documentation of each
+component of TradingMate.
+
+
+TradingMate
+^^^^^^^^^^^
+
+.. automodule:: TradingMate
+
+.. autoclass:: TradingMate
+    :members:
+
+Model
+^^^^^
+
+The ``Model`` module contains the business logic and the data management of
+TradingMate.
+
+Model
+"""""
+
+.. automodule:: Model.Model
+
+.. autoclass:: Model
+    :members:
+
+Holding
+"""""""
+
+.. automodule:: Model.Holding
+
+.. autoclass:: Holding
+    :members:
+
+Portfolio
+"""""""""
+
+.. automodule:: Model.Portfolio
+
+.. autoclass:: Portfolio
+    :members:
+
+UI
+^^^
+
+The ``UI`` module contains the components that compose the User Interface
+of TradingMate.
+
+View
+""""
+
+.. automodule:: UI.View
+
+.. autoclass:: View
+    :members:
+
+ShareTradingFrame
+"""""""""""""""""
+
+.. automodule:: UI.ShareTradingFrame
+
+.. autoclass:: ShareTradingFrame
+    :members:
+
+AddTradeDialogWindow
+""""""""""""""""""""
+
+.. automodule:: UI.AddTradeDialogWindow
+
+.. autoclass:: AddTradeDialogWindow
+    :members:
+
+WarningWindow
+"""""""""""""
+
+.. automodule:: UI.WarningWindow
+
+.. autoclass:: WarningWindow
+    :members:
+
+Widgets
+"""""""
+
+.. automodule:: UI.Widgets
+
+.. autoclass:: DatePicker
+    :members:
+
+Utils
+^^^^^
+
+The ``Utils`` module contains all the utlity components.
+
+
+ConfigurationManager
+^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: Utils.ConfigurationManager
+
+.. autoclass:: ConfigurationManager
+    :members:
+
+TaskThread
+^^^^^^^^^^
+
+.. automodule:: Utils.TaskThread
+
+.. autoclass:: TaskThread
+    :members:
+
+Utils
+^^^^^
+
+.. automodule:: Utils.Utils
+
+.. autoclass:: Callbacks
+    :members:
+
+.. autoclass:: Actions
+    :members:
+
+.. autoclass:: Messages
+    :members:
+
+.. autoclass:: Markets
+    :members:
diff --git a/docs/source/system.rst b/docs/source/system.rst
@@ -0,0 +1,16 @@
+System Overview
+===============
+
+TradingMate is a portfolio manager with the goal to help traders to record
+their trades and deals in the stock market providing useful statistics and
+metrics to help backtest and review trade performance.
+It offers a simple user interface that provide information about the current
+asset value, the overall profit/loss indicator and the trade history.
+
+TradingMate
+"""""""""""
+
+TradingMate is the main entiy used to initialised all the
+components. It is the link between the user interface and the data.
+
+TODO
diff --git a/src/UI/AutoTradingFrame.py b/src/UI/AutoTradingFrame.py
diff --git a/src/UI/View.py b/src/UI/View.py
@@ -12,7 +12,6 @@
 from Utils.Utils import Callbacks, Messages
 from .WarningWindow import WarningWindow
 from .ShareTradingFrame import ShareTradingFrame
-from .AutoTradingFrame import AutoTradingFrame
 
 APP_NAME = "TradingMate"