docs: added docs files

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.https://www.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/AutoTrader.rst

@@ -0,0 +1,18 @@
+AutoTrader
+==========
+
+AutoTrader is the main module where you will run things from.
+
+
+
+AutoTrader
+-----------
+
+More AutoTrader
+---------------
+
+.. automodule:: autotrader.autotrader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

docs/source/autotrader.brokers.ib.rst

@@ -0,0 +1,29 @@
+autotrader.brokers.ib package
+=============================
+
+Submodules
+----------
+
+autotrader.brokers.ib.broker module
+-----------------------------------
+
+.. automodule:: autotrader.brokers.ib.broker
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+autotrader.brokers.ib.utils module
+----------------------------------
+
+.. automodule:: autotrader.brokers.ib.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: autotrader.brokers.ib
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/autotrader.brokers.oanda.rst

@@ -0,0 +1,29 @@
+autotrader.brokers.oanda package
+================================
+
+Submodules
+----------
+
+autotrader.brokers.oanda.broker module
+--------------------------------------
+
+.. automodule:: autotrader.brokers.oanda.broker
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+autotrader.brokers.oanda.utils module
+-------------------------------------
+
+.. automodule:: autotrader.brokers.oanda.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: autotrader.brokers.oanda
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/autotrader.brokers.rst

@@ -0,0 +1,39 @@
+autotrader.brokers package
+==========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   autotrader.brokers.ib
+   autotrader.brokers.oanda
+   autotrader.brokers.virtual
+
+Submodules
+----------
+
+autotrader.brokers.broker\_utils module
+---------------------------------------
+
+.. automodule:: autotrader.brokers.broker_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+autotrader.brokers.trading module
+---------------------------------
+
+.. automodule:: autotrader.brokers.trading
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: autotrader.brokers
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/autotrader.brokers.virtual.rst

@@ -0,0 +1,29 @@
+autotrader.brokers.virtual package
+==================================
+
+Submodules
+----------
+
+autotrader.brokers.virtual.broker module
+----------------------------------------
+
+.. automodule:: autotrader.brokers.virtual.broker
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+autotrader.brokers.virtual.utils module
+---------------------------------------
+
+.. automodule:: autotrader.brokers.virtual.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: autotrader.brokers.virtual
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/autotrader.comms.rst

@@ -0,0 +1,21 @@
+autotrader.comms package
+========================
+
+Submodules
+----------
+
+autotrader.comms.emailing module
+--------------------------------
+
+.. automodule:: autotrader.comms.emailing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: autotrader.comms
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/autotrader.data.rst

@@ -0,0 +1,10 @@
+autotrader.data package
+=======================
+
+Module contents
+---------------
+
+.. automodule:: autotrader.data
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/autotrader.rst

@@ -0,0 +1,79 @@
+autotrader package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   autotrader.brokers
+   autotrader.comms
+   autotrader.data
+
+Submodules
+----------
+
+autotrader.autobot module
+-------------------------
+
+.. automodule:: autotrader.autobot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+autotrader.autodata module
+--------------------------
+
+.. automodule:: autotrader.autodata
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+autotrader.autoplot module
+--------------------------
+
+.. automodule:: autotrader.autoplot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+autotrader.autostream module
+----------------------------
+
+.. automodule:: autotrader.autostream
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+autotrader.autotrader module
+----------------------------
+
+.. automodule:: autotrader.autotrader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+autotrader.indicators module
+----------------------------
+
+.. automodule:: autotrader.indicators
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+autotrader.utilities module
+---------------------------
+
+.. automodule:: autotrader.utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: autotrader
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../autotrader'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'AutoTrader'
+copyright = '2022, Kieran Mackle'
+author = 'Kieran Mackle'
+
+# The full version, including alpha/beta/rc tags
+release = '0.6.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+        'sphinx.ext.autodoc',
+        'sphinx.ext.napoleon',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'furo'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']