Add Docs

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

@@ -0,0 +1,31 @@
+import sys
+import os
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'pydualsense'
+copyright = '2022, flok'
+author = 'flok'
+release = '0.6.1'
+
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../../'))
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.coverage']
+
+templates_path = ['templates']
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'furo'
+html_static_path = ['static']

docs/source/index.rst

@@ -0,0 +1,19 @@
+Welcome to pydualsense's documentation!
+=======================================
+
+
+**pydualsense** is a Python library that helps you interact with your PlayStation 5 DualSense controller. It reads the current state of the controller and also allows to update the triggers and other options on the controller.
+
+To get started check out the :doc:`usage` section for more information on how to install.
+
+
+.. note::
+   This project is under active development.
+
+Contents
+--------
+
+.. toctree::
+   usage
+   pydualsense
+   modules

docs/source/modules.rst

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

docs/source/pydualsense.rst

@@ -0,0 +1,45 @@
+pydualsense package
+===================
+
+Submodules
+----------
+
+pydualsense.enums module
+------------------------
+
+.. automodule:: pydualsense.enums
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pydualsense.event\_system module
+--------------------------------
+
+.. automodule:: pydualsense.event_system
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pydualsense.hidguardian module
+------------------------------
+
+.. automodule:: pydualsense.hidguardian
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pydualsense.pydualsense module
+------------------------------
+
+.. automodule:: pydualsense.pydualsense
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pydualsense
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/usage.rst

@@ -0,0 +1,11 @@
+Usage
+=====
+
+Installation
+------------
+
+To use **pydualsense**, first install it using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install --upgrade pydualsense