Update documentation

FUNDING.yml

@@ -1,2 +1,2 @@
 ko_fi: Jaxcie
-github: Jaxc
+github: Jaxc

README.md

@@ -16,8 +16,19 @@ functions completely.
 
 The next few versions will probably be patched to bring the documentation up to date.
 
+# Documentation
+Documentation is available on [readthedocs.io](https://pystagelinq.readthedocs.io/en/latest/)
+
+# Installation
+`pip install PyStageLinQ`
+
+
+# Issue tracking
+If you find an issue, please report check known issues, and if the issue is not mentioned please report it 
+[here](https://github.com/Jaxc/PyStageLinQ)
+
 # Example usage
-Here follow an example of how PyStageLinQ can be used, and 
+Here follow an example of how PyStageLinQ can be used:
 
 ```python
 from PyStageLinQ import EngineServices, PyStageLinQ
@@ -71,22 +82,3 @@ PyStageLinQ has been tested with a Denon DJ Prime Go on Windows 10 and Linux (Mi
 # Acknowledgements
 Big thanks to icedream for his implementation of StageLinQ in go:
 https://github.com/icedream/go-stagelinq
-
-# Change log
-Here follows a log of released versions of PyStageLinQ.
-## [0.1.0] Inital release
-Basic functionality done, but documentation needs to be done. I expect the API to change when I write this, so this is
-a pre-release until Documentation is in place.
-### Added
-Everything
-### Changes
-Yes
-### Fixed
-Some things
-### Security
-No
-### Knows issues
-There are currently one known issue:
-#### PyStageLinq cannot connect to device
-For some reason that I cannot figure out PyStageLinQ cannot connect to my Prime Go sometimes. This seems to be
-completely random and is because the device does not send a table of services when requested

changelog.md

@@ -0,0 +1,32 @@
+# Changelog
+Here follows a log of released versions of PyStageLinQ.
+
+## [0.1.1] - Documentation update
+Added documentation
+### Added
+docs/folder with documentation, run `make html` to create documentation. It is also available at h
+https://pystagelinq.readthedocs.io/en/latest/
+
+### Changes
+Some code has been changed to better correspond to how it is used. This mostly means that functions has been marked
+as private.
+
+### Known Issues
+Same known issues as for version 0.1.0.
+
+## [0.1.0] - Inital release
+Basic functionality done, but documentation needs to be done. I expect the API to change when I write this, so this is
+a pre-release until Documentation is in place.
+### Added
+Everything
+### Changes
+Yes
+### Fixed
+Some things
+### Security
+No
+### Known Issues
+There are currently one known issue:
+#### PyStageLinq cannot connect to device
+For some reason that I cannot figure out PyStageLinQ cannot connect to my Prime Go sometimes. This seems to be
+completely random and is because the device does not send a table of services when requested

docs/api.rst

@@ -0,0 +1,13 @@
+API
+***
+
+.. module:: PyStageLinQ
+
+This documentation describes the API of PyStageLinQ
+
+Application Object
+------------------
+
+.. autoclass:: PyStageLinQ.PyStageLinQ.PyStageLinQ
+   :members:
+   :inherited-members:

docs/changelog_link.rst

@@ -0,0 +1,4 @@
+Version info
+************
+
+.. mdinclude:: ../changelog.md

docs/conf.py

@@ -10,10 +10,10 @@
 # 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('.'))
-
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+import sphinx_rtd_theme
 
 # -- Project information -----------------------------------------------------
 
@@ -30,7 +30,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
+extensions = ["sphinx_rtd_theme", "sphinx_mdinclude", 'sphinx.ext.autodoc'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -47,7 +47,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # 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,

docs/index.rst

@@ -1,8 +1,3 @@
-.. PyStageLinQ documentation master file, created by
-   sphinx-quickstart on Sat Jul  9 11:51:12 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 PyStageLinQ
 =======================================
 
@@ -12,29 +7,14 @@ PyStageLinQ
    :maxdepth: 2
    :caption: Contents:
 
+   readme_link
+
+   changelog_link
 
+   api
 
 Indices and tables
 ==================
-
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
-Installation
-------------
-
-Install PyStageLinQ by running:
-
-    pip install PyStageLinQ
-
-Contribute
-----------
-
-- Issue Tracker: https://github.com/Jaxc/PyStageLinQ/issues
-- Source Code: https://github.com/Jaxc/PyStageLinQ
-
-License
--------
-
-The project is licensed under the BSD license.

docs/readme_link.rst

@@ -0,0 +1,4 @@
+Quickstart
+************
+
+.. mdinclude:: ../README.md

pyproject.toml

@@ -23,4 +23,5 @@ keywords = ["StageLinQ", "DJ", "VJ", "Denon DJ", "Prime Go", "Streaming"]
 [project.urls]
 "Homepage" = "https://github.com/Jaxc/PyStageLinQ"
 "Bug Tracker" = "https://github.com/Jaxc/PyStageLinQ/issues"
+"Documentation" = "https://pystagelinq.readthedocs.io/en/latest/"
 "Funding" = "https://ko-fi.com/jaxcie"