Docstrings and API docs

[SpectralVectors]

Docstrings and API docs site

Added docstrings to functions to help explain what the function does, what arguments it takes, and to lay the foundation for API docs.
e.g.

def function(a, b):
"""function takes two floats and multiplies them.

    Args
        a (float) The first float value
        b (float) The second float value
    Returns
        result (float) The result of the multiplication operation.
"""

Then added and streamlined a Github workflow to auto-build and host the API documentation site on Github Pages.

Preview

API Docs

NOTE

You must enable Github Pages, and set it to build from the branch 'gh-pages' '(root)'.
This branch will be automatically created the first time the workflow runs, so you will need to let it run once, then go into the repository settings, enable Pages, and set it to build from the gh-pages branch.