Beginning documentation

.github/workflows/ci.yml

@@ -60,6 +60,46 @@ jobs:
       # - name: Run JavaScript Tests
       #   run: npm test
 
+  generate docs:
+    runs-on: ubuntu-20.04
+    needs: build # for ignoring bad builds
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    steps:
+      - uses: actions/checkout@v2 # get source
+
+      # PYTHON
+      - name: Install Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      # PYTHON for dependency export only, not installing
+      - name: Install Poetry 1.1.4
+        uses: abatilo/actions-poetry@v2.1.0
+        with:
+          poetry-version: 1.1.4
+
+      # PYTHON install dependencies
+      - name: Install Python Dependencies
+        run: poetry install
+
+      # DEPLOY for setting up cloud API
+      - name: Set up Cloud SDK
+        uses: google-github-actions/setup-gcloud@master
+        with:
+          project_id: ${{ secrets.GCP_PROJECT_ID }}
+          service_account_key: ${{ secrets.GCP_SA_KEY }}
+          export_default_credentials: true # <=== need to run through modules later generating docs
+
+      - name: Generate Documentation
+        run: sphinx-build docs public -b html
+
+      - name: Deploy To Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./public
+
   deploy:
     runs-on: ubuntu-20.04
     needs: build # for ignoring bad builds

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     = src
+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/conf.py

@@ -0,0 +1,52 @@
+# 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('..'))
+# sys.setrecursionlimit(1500)
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Music Tools'
+copyright = '2021, Sarsoo'
+author = 'Sarsoo'
+
+
+# -- 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.coverage', '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 = ['_build', 'Thumbs.db', '.DS_Store', 'venv']
+
+
+# -- 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 = 'alabaster'
+
+# 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']

docs/index.rst

@@ -0,0 +1,30 @@
+Music Tools
+=======================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   Modules <src/modules>
+   src/music
+   src/music.api
+   src/music.auth
+   src/music.cloud
+   src/music.db
+   src/music.model
+   src/music.tasks
+
+Music Tools
+-------------
+
+.. image:: https://github.com/sarsoo/music-tools/workflows/test%20and%20deploy/badge.svg
+
+Music Tools is a web app for creating smart Spotify playlists.
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

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=.
+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.http://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/src/modules.rst

@@ -0,0 +1,7 @@
+music
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   music

docs/src/music.api.rst

@@ -0,0 +1,77 @@
+music.api package
+=================
+
+Submodules
+----------
+
+music.api.admin module
+----------------------
+
+.. automodule:: music.api.admin
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.api.api module
+--------------------
+
+.. automodule:: music.api.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.api.decorators module
+---------------------------
+
+.. automodule:: music.api.decorators
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.api.fm module
+-------------------
+
+.. automodule:: music.api.fm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.api.player module
+-----------------------
+
+.. automodule:: music.api.player
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.api.spotfm module
+-----------------------
+
+.. automodule:: music.api.spotfm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.api.spotify module
+------------------------
+
+.. automodule:: music.api.spotify
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.api.tag module
+--------------------
+
+.. automodule:: music.api.tag
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: music.api
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/src/music.auth.rst

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

docs/src/music.cloud.rst

@@ -0,0 +1,29 @@
+music.cloud package
+===================
+
+Submodules
+----------
+
+music.cloud.function module
+---------------------------
+
+.. automodule:: music.cloud.function
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.cloud.tasks module
+------------------------
+
+.. automodule:: music.cloud.tasks
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: music.cloud
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/src/music.db.rst

@@ -0,0 +1,29 @@
+music.db package
+================
+
+Submodules
+----------
+
+music.db.database module
+------------------------
+
+.. automodule:: music.db.database
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.db.part\_generator module
+-------------------------------
+
+.. automodule:: music.db.part_generator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: music.db
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/src/music.model.rst

@@ -0,0 +1,45 @@
+music.model package
+===================
+
+Submodules
+----------
+
+music.model.config module
+-------------------------
+
+.. automodule:: music.model.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.model.playlist module
+---------------------------
+
+.. automodule:: music.model.playlist
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.model.tag module
+----------------------
+
+.. automodule:: music.model.tag
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.model.user module
+-----------------------
+
+.. automodule:: music.model.user
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: music.model
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/src/music.rst

@@ -0,0 +1,34 @@
+music package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   music.api
+   music.auth
+   music.cloud
+   music.db
+   music.model
+   music.tasks
+
+Submodules
+----------
+
+music.music module
+------------------
+
+.. automodule:: music.music
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: music
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/src/music.tasks.rst

@@ -0,0 +1,45 @@
+music.tasks package
+===================
+
+Submodules
+----------
+
+music.tasks.create\_playlist module
+-----------------------------------
+
+.. automodule:: music.tasks.create_playlist
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.tasks.refresh\_lastfm\_stats module
+-----------------------------------------
+
+.. automodule:: music.tasks.refresh_lastfm_stats
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.tasks.run\_user\_playlist module
+--------------------------------------
+
+.. automodule:: music.tasks.run_user_playlist
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+music.tasks.update\_tag module
+------------------------------
+
+.. automodule:: music.tasks.update_tag
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: music.tasks
+   :members:
+   :undoc-members:
+   :show-inheritance:

music/__init__.py

@@ -1,3 +1,9 @@
+"""Root module containing Music Tools backend
+
+Top level module with functions for creating app with loaded blueprints and initialising the logging stack
+
+"""
+
 import logging
 import os
 

music/api/__init__.py

@@ -1,3 +1,6 @@
+"""Flask blueprints for loading the app endpoints
+"""
+
 from .api import blueprint as api_blueprint
 from .player import blueprint as player_blueprint
 from .fm import blueprint as fm_blueprint

music/api/api.py

@@ -30,6 +30,15 @@ logger = logging.getLogger(__name__)
 @blueprint.route('/playlists', methods=['GET'])
 @login_or_basic_auth
 def all_playlists_route(user=None):
+    """Retrieve all playlists for a given user
+
+    Args:
+        user ([type], optional): [description]. Defaults to None.
+
+    Returns:
+        HTTP Response: All playlists for given user
+    """
+
     assert user is not None
     return jsonify({
         'playlists': [i.to_dict() for i in Playlist.collection.parent(user.key).fetch()]

music/auth/__init__.py

@@ -1 +1,4 @@
+"""Security related endpoints including login/logout and reset password
+"""
+
 from .auth import blueprint as auth_blueprint

music/auth/auth.py

@@ -16,6 +16,11 @@ logger = logging.getLogger(__name__)
 
 @blueprint.route('/login', methods=['GET', 'POST'])
 def login():
+    """Login route allowing retrieval of HTML page and submission of results
+
+    Returns:
+        HTTP Response: Home page redirect for GET, login request on POST
+    """
 
     if request.method == 'POST':
 

music/cloud/__init__.py

@@ -1,3 +1,6 @@
+"""Infrastucture code include handing off tasks to Cloud Tasks or Cloud Functions
+"""
+
 import logging
 
 from music.model.config import Config

music/db/__init__.py

@@ -0,0 +1,2 @@
+"""Database interfacing components aside from the music.model ORM layer
+"""

music/model/__init__.py

@@ -0,0 +1,2 @@
+"""ORM layer containing the data model
+"""

music/model/playlist.py

@@ -11,6 +11,14 @@ class Sort(Enum):
 
 
 class Playlist(Model):
+    """Smart playlist
+
+    Args:
+        Model ([type]): [description]
+
+    Returns:
+        [type]: [description]
+    """
     class Meta:
         collection_name = 'playlists'
 

music/music.py

@@ -12,6 +12,12 @@ logger = logging.getLogger(__name__)
 
 
 def create_app():
+    """Generate and retrieve a ready-to-run flask app
+
+    Returns:
+        Flask App: Music Tools app
+    """
+
     app = Flask(__name__, static_folder=os.path.join(os.path.dirname(__file__), '..', 'build'), template_folder="templates")
 
     config = Config.collection.get("config/music-tools")

music/tasks/__init__.py

@@ -0,0 +1,2 @@
+"""Long running operations of the app including playlist generation and tag update functions
+"""

poetry.lock

@@ -1,3 +1,11 @@
+[[package]]
+name = "alabaster"
+version = "0.7.12"
+description = "A configurable sidebar-enabled Sphinx theme"
+category = "dev"
+optional = false
+python-versions = "*"
+
 [[package]]
 name = "astroid"
 version = "2.5"
@@ -10,6 +18,17 @@ python-versions = ">=3.6"
 lazy-object-proxy = ">=1.4.0"
 wrapt = ">=1.11,<1.13"
 
+[[package]]
+name = "babel"
+version = "2.9.0"
+description = "Internationalization utilities"
+category = "dev"
+optional = false
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+
+[package.dependencies]
+pytz = ">=2015.7"
+
 [[package]]
 name = "backports-datetime-fromisoformat"
 version = "1.0.0"
@@ -73,6 +92,14 @@ category = "dev"
 optional = false
 python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
 
+[[package]]
+name = "docutils"
+version = "0.16"
+description = "Docutils -- Python Documentation Utilities"
+category = "dev"
+optional = false
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
+
 [[package]]
 name = "fireo"
 version = "1.4.1"
@@ -281,6 +308,14 @@ category = "main"
 optional = false
 python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
 
+[[package]]
+name = "imagesize"
+version = "1.2.0"
+description = "Getting image size from png/jpeg/jpeg2000/gif file"
+category = "dev"
+optional = false
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+
 [[package]]
 name = "isort"
 version = "4.3.21"
@@ -382,6 +417,14 @@ python-versions = "*"
 [package.dependencies]
 pyasn1 = ">=0.4.6,<0.5.0"
 
+[[package]]
+name = "pygments"
+version = "2.8.1"
+description = "Pygments is a syntax highlighting package written in Python."
+category = "dev"
+optional = false
+python-versions = ">=3.5"
+
 [[package]]
 name = "pylint"
 version = "2.5.3"
@@ -450,6 +493,14 @@ category = "main"
 optional = false
 python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*"
 
+[[package]]
+name = "snowballstemmer"
+version = "2.1.0"
+description = "This package provides 29 stemmers for 28 languages generated from Snowball algorithms."
+category = "dev"
+optional = false
+python-versions = "*"
+
 [[package]]
 name = "soupsieve"
 version = "2.2.1"
@@ -458,6 +509,108 @@ category = "main"
 optional = false
 python-versions = ">=3.6"
 
+[[package]]
+name = "sphinx"
+version = "3.5.3"
+description = "Python documentation generator"
+category = "dev"
+optional = false
+python-versions = ">=3.5"
+
+[package.dependencies]
+alabaster = ">=0.7,<0.8"
+babel = ">=1.3"
+colorama = {version = ">=0.3.5", markers = "sys_platform == \"win32\""}
+docutils = ">=0.12"
+imagesize = "*"
+Jinja2 = ">=2.3"
+packaging = "*"
+Pygments = ">=2.0"
+requests = ">=2.5.0"
+snowballstemmer = ">=1.1"
+sphinxcontrib-applehelp = "*"
+sphinxcontrib-devhelp = "*"
+sphinxcontrib-htmlhelp = "*"
+sphinxcontrib-jsmath = "*"
+sphinxcontrib-qthelp = "*"
+sphinxcontrib-serializinghtml = "*"
+
+[package.extras]
+docs = ["sphinxcontrib-websupport"]
+lint = ["flake8 (>=3.5.0)", "isort", "mypy (>=0.800)", "docutils-stubs"]
+test = ["pytest", "pytest-cov", "html5lib", "cython", "typed-ast"]
+
+[[package]]
+name = "sphinxcontrib-applehelp"
+version = "1.0.2"
+description = "sphinxcontrib-applehelp is a sphinx extension which outputs Apple help books"
+category = "dev"
+optional = false
+python-versions = ">=3.5"
+
+[package.extras]
+lint = ["flake8", "mypy", "docutils-stubs"]
+test = ["pytest"]
+
+[[package]]
+name = "sphinxcontrib-devhelp"
+version = "1.0.2"
+description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp document."
+category = "dev"
+optional = false
+python-versions = ">=3.5"
+
+[package.extras]
+lint = ["flake8", "mypy", "docutils-stubs"]
+test = ["pytest"]
+
+[[package]]
+name = "sphinxcontrib-htmlhelp"
+version = "1.0.3"
+description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files"
+category = "dev"
+optional = false
+python-versions = ">=3.5"
+
+[package.extras]
+lint = ["flake8", "mypy", "docutils-stubs"]
+test = ["pytest", "html5lib"]
+
+[[package]]
+name = "sphinxcontrib-jsmath"
+version = "1.0.1"
+description = "A sphinx extension which renders display math in HTML via JavaScript"
+category = "dev"
+optional = false
+python-versions = ">=3.5"
+
+[package.extras]
+test = ["pytest", "flake8", "mypy"]
+
+[[package]]
+name = "sphinxcontrib-qthelp"
+version = "1.0.3"
+description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp document."
+category = "dev"
+optional = false
+python-versions = ">=3.5"
+
+[package.extras]
+lint = ["flake8", "mypy", "docutils-stubs"]
+test = ["pytest"]
+
+[[package]]
+name = "sphinxcontrib-serializinghtml"
+version = "1.1.4"
+description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)."
+category = "dev"
+optional = false
+python-versions = ">=3.5"
+
+[package.extras]
+lint = ["flake8", "mypy", "docutils-stubs"]
+test = ["pytest"]
+
 [[package]]
 name = "spotfm"
 version = "1.0.0"
@@ -552,13 +705,21 @@ python-versions = "*"
 [metadata]
 lock-version = "1.1"
 python-versions = "^3.8"
-content-hash = "943b58ae3ae110c4c990bab3fa72b73b0f8a172905246839c2fe481c73919067"
+content-hash = "431e5847206f8cb132be7004542e75b7ac13d60266ff1816744f7f3bd48bd664"
 
 [metadata.files]
+alabaster = [
+    {file = "alabaster-0.7.12-py2.py3-none-any.whl", hash = "sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359"},
+    {file = "alabaster-0.7.12.tar.gz", hash = "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02"},
+]
 astroid = [
     {file = "astroid-2.5-py3-none-any.whl", hash = "sha256:87ae7f2398b8a0ae5638ddecf9987f081b756e0e9fc071aeebdca525671fc4dc"},
     {file = "astroid-2.5.tar.gz", hash = "sha256:b31c92f545517dcc452f284bc9c044050862fbe6d93d2b3de4a215a6b384bf0d"},
 ]
+babel = [
+    {file = "Babel-2.9.0-py2.py3-none-any.whl", hash = "sha256:9d35c22fcc79893c3ecc85ac4a56cde1ecf3f19c540bba0922308a6c06ca6fa5"},
+    {file = "Babel-2.9.0.tar.gz", hash = "sha256:da031ab54472314f210b0adcff1588ee5d1d1d0ba4dbd07b94dba82bde791e05"},
+]
 backports-datetime-fromisoformat = [
     {file = "backports-datetime-fromisoformat-1.0.0.tar.gz", hash = "sha256:9577a2a9486cd7383a5f58b23bb8e81cf0821dbbc0eb7c87d3fa198c1df40f5c"},
 ]
@@ -587,6 +748,10 @@ colorama = [
     {file = "colorama-0.4.4-py2.py3-none-any.whl", hash = "sha256:9f47eda37229f68eee03b24b9748937c7dc3868f906e8ba69fbcbdd3bc5dc3e2"},
     {file = "colorama-0.4.4.tar.gz", hash = "sha256:5941b2b48a20143d2267e95b1c2a7603ce057ee39fd88e7329b0c292aa16869b"},
 ]
+docutils = [
+    {file = "docutils-0.16-py2.py3-none-any.whl", hash = "sha256:0c5b78adfbf7762415433f5515cd5c9e762339e23369dbe8000d84a4bf4ab3af"},
+    {file = "docutils-0.16.tar.gz", hash = "sha256:c2de3a60e9e7d07be26b7f2b00ca0309c207e06c100f9cc2a94931fc75a478fc"},
+]
 fireo = [
     {file = "fireo-1.4.1.tar.gz", hash = "sha256:f210cc1e73e7f8c06cb4f2dda256c3df47fb0413326c049d5b558d8437a8d4c0"},
 ]
@@ -682,6 +847,10 @@ idna = [
     {file = "idna-2.10-py2.py3-none-any.whl", hash = "sha256:b97d804b1e9b523befed77c48dacec60e6dcb0b5391d57af6a65a312a90648c0"},
     {file = "idna-2.10.tar.gz", hash = "sha256:b307872f855b18632ce0c21c5e45be78c0ea7ae4c15c828c20788b26921eb3f6"},
 ]
+imagesize = [
+    {file = "imagesize-1.2.0-py2.py3-none-any.whl", hash = "sha256:6965f19a6a2039c7d48bca7dba2473069ff854c36ae6f19d2cde309d998228a1"},
+    {file = "imagesize-1.2.0.tar.gz", hash = "sha256:b1f6b5a4eab1f73479a50fb79fcf729514a900c341d8503d62a62dbc4127a2b1"},
+]
 isort = [
     {file = "isort-4.3.21-py2.py3-none-any.whl", hash = "sha256:6e811fcb295968434526407adb8796944f1988c5b65e8139058f2014cbe100fd"},
     {file = "isort-4.3.21.tar.gz", hash = "sha256:54da7e92468955c4fceacd0c86bd0ec997b0e1ee80d97f67c35a78b719dccab1"},
@@ -815,6 +984,10 @@ pyasn1-modules = [
     {file = "pyasn1_modules-0.2.8-py3.6.egg", hash = "sha256:cbac4bc38d117f2a49aeedec4407d23e8866ea4ac27ff2cf7fb3e5b570df19e0"},
     {file = "pyasn1_modules-0.2.8-py3.7.egg", hash = "sha256:c29a5e5cc7a3f05926aff34e097e84f8589cd790ce0ed41b67aed6857b26aafd"},
 ]
+pygments = [
+    {file = "Pygments-2.8.1-py3-none-any.whl", hash = "sha256:534ef71d539ae97d4c3a4cf7d6f110f214b0e687e92f9cb9d2a3b0d3101289c8"},
+    {file = "Pygments-2.8.1.tar.gz", hash = "sha256:2656e1a6edcdabf4275f9a3640db59fd5de107d88e8663c5d4e9a0fa62f77f94"},
+]
 pylint = [
     {file = "pylint-2.5.3-py3-none-any.whl", hash = "sha256:d0ece7d223fe422088b0e8f13fa0a1e8eb745ebffcb8ed53d3e95394b6101a1c"},
     {file = "pylint-2.5.3.tar.gz", hash = "sha256:7dd78437f2d8d019717dbf287772d0b2dbdfd13fc016aa7faa08d67bccc46adc"},
@@ -839,10 +1012,42 @@ six = [
     {file = "six-1.15.0-py2.py3-none-any.whl", hash = "sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced"},
     {file = "six-1.15.0.tar.gz", hash = "sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259"},
 ]
+snowballstemmer = [
+    {file = "snowballstemmer-2.1.0-py2.py3-none-any.whl", hash = "sha256:b51b447bea85f9968c13b650126a888aabd4cb4463fca868ec596826325dedc2"},
+    {file = "snowballstemmer-2.1.0.tar.gz", hash = "sha256:e997baa4f2e9139951b6f4c631bad912dfd3c792467e2f03d7239464af90e914"},
+]
 soupsieve = [
     {file = "soupsieve-2.2.1-py3-none-any.whl", hash = "sha256:c2c1c2d44f158cdbddab7824a9af8c4f83c76b1e23e049479aa432feb6c4c23b"},
     {file = "soupsieve-2.2.1.tar.gz", hash = "sha256:052774848f448cf19c7e959adf5566904d525f33a3f8b6ba6f6f8f26ec7de0cc"},
 ]
+sphinx = [
+    {file = "Sphinx-3.5.3-py3-none-any.whl", hash = "sha256:3f01732296465648da43dec8fb40dc451ba79eb3e2cc5c6d79005fd98197107d"},
+    {file = "Sphinx-3.5.3.tar.gz", hash = "sha256:ce9c228456131bab09a3d7d10ae58474de562a6f79abb3dc811ae401cf8c1abc"},
+]
+sphinxcontrib-applehelp = [
+    {file = "sphinxcontrib-applehelp-1.0.2.tar.gz", hash = "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58"},
+    {file = "sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl", hash = "sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a"},
+]
+sphinxcontrib-devhelp = [
+    {file = "sphinxcontrib-devhelp-1.0.2.tar.gz", hash = "sha256:ff7f1afa7b9642e7060379360a67e9c41e8f3121f2ce9164266f61b9f4b338e4"},
+    {file = "sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl", hash = "sha256:8165223f9a335cc1af7ffe1ed31d2871f325254c0423bc0c4c7cd1c1e4734a2e"},
+]
+sphinxcontrib-htmlhelp = [
+    {file = "sphinxcontrib-htmlhelp-1.0.3.tar.gz", hash = "sha256:e8f5bb7e31b2dbb25b9cc435c8ab7a79787ebf7f906155729338f3156d93659b"},
+    {file = "sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl", hash = "sha256:3c0bc24a2c41e340ac37c85ced6dafc879ab485c095b1d65d2461ac2f7cca86f"},
+]
+sphinxcontrib-jsmath = [
+    {file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"},
+    {file = "sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178"},
+]
+sphinxcontrib-qthelp = [
+    {file = "sphinxcontrib-qthelp-1.0.3.tar.gz", hash = "sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72"},
+    {file = "sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl", hash = "sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6"},
+]
+sphinxcontrib-serializinghtml = [
+    {file = "sphinxcontrib-serializinghtml-1.1.4.tar.gz", hash = "sha256:eaa0eccc86e982a9b939b2b82d12cc5d013385ba5eadcc7e4fed23f4405f77bc"},
+    {file = "sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl", hash = "sha256:f242a81d423f59617a8e5cf16f5d4d74e28ee9a66f9e5b637a18082991db5a9a"},
+]
 spotfm = []
 spotframework = []
 tabulate = [

pyproject.toml

@@ -26,7 +26,8 @@ fmframework = { git = "https://github.com/Sarsoo/pyfmframework.git" }
 spotfm = { git = "https://github.com/Sarsoo/spotfm.git" }
 
 [tool.poetry.dev-dependencies]
-pylint = "2.5.3"
+pylint = "^2.5.3"
+Sphinx = "^3.5.3"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]