Make the chesslib lintable when being imported in Python projects

[Bonifatius94]

Issue:

• the functions of the chesslib are not properly lintable
• there is no proper information on the use of each lib function

Suggested Solution:

• add something like an API documentation that can be linted
• add deployment jobs to the GitHub workflow (if required)

[Bonifatius94]

use this example: https://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format

[Bonifatius94]

Task Roadmap:

1) added Sphynx-like syntax to a function (for testing) 2) trying to export this doc strings to a HTML documentation 3) making sure that IDEs show the docstring correctly, so the user sees help text when typing in the function name, etc. 4) add API doc to all module functions (do this last to save rewriting effort)

[Bonifatius94]

following steps had to be taken to install the chesslib package as is (without requiring to do PyPI build pipeline stuff):

# make sure to clear already installed versions of chesslib
pip3 uninstall chesslib

# build and install chesslib from source code
python3 setup.py install --user

[Bonifatius94]

try following tutorial for API doc generation https://shunsvineyard.info/2019/09/19/use-sphinx-for-python-documentation/

[Bonifatius94]

• added docstring definitions for each module function
• made the module docstrings visible to pylint (unfortunately not pylance)
• remaining issue: constants are not lintable -> figure out if there is a way