#29 Sphinx config, package.rst and make updates.

Make has been adjusted to use whatever python your virtual env is using.

docs/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line, and also
 # from the environment for the first two.
 SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
+SPHINXBUILD   ?= python -m sphinx
 SOURCEDIR     = .
 BUILDDIR      = _build
 

docs/conf.py

@@ -18,9 +18,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'qttk'
+project = '[qttk] Quantitative Trading ToolKit'
 copyright = '2021, Conlan Scientific'
-author = 'Conlan Scientific'
+author = 'Conlan Scientific Open-source Development Cohort'
 
 
 # -- General configuration ---------------------------------------------------
@@ -31,7 +31,8 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx_autodoc_typehints',
-    'sphinx_rtd_theme'
+    'sphinx_rtd_theme',
+    'sphinx.ext.autosummary'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -53,4 +54,4 @@
 # 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']
+html_static_path = []

docs/make.bat

@@ -5,7 +5,7 @@ pushd %~dp0
 REM Command file for Sphinx documentation
 
 if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
+	set SPHINXBUILD=python -m sphinx
 )
 set SOURCEDIR=.
 set BUILDDIR=_build

docs/qttk.rst

@@ -1,16 +1,24 @@
-qttk package
-============
+Indicators
+==========
 
-Subpackages
------------
+qttk.indicators module
+----------------------
+
+.. automodule:: qttk.indicators
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Utils
+=====
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 2
 
    qttk.utils
 
 Submodules
-----------
+==========
 
 qttk.bollinger module
 ---------------------
@@ -44,14 +52,6 @@ qttk.ema module
    :undoc-members:
    :show-inheritance:
 
-qttk.indicators module
-----------------------
-
-.. automodule:: qttk.indicators
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 qttk.lin\_reg module
 --------------------
 

docs/qttk.utils.rst

@@ -1,9 +1,6 @@
 qttk.utils package
 ==================
 
-Submodules
-----------
-
 qttk.utils.data\_utils module
 -----------------------------
 
@@ -36,9 +33,6 @@ qttk.utils.sample\_data module
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
-
 .. automodule:: qttk.utils
    :members:
    :undoc-members: