some formatting changes adding some docs

Author: bookman-dius

docs/.gitignore

@@ -0,0 +1 @@
+build/

docs/Makefile

@@ -0,0 +1,14 @@
+# Minimal makefile for Sphinx documentation
+
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

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=source
+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.https://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/source/_static/powersensor-logo.png

@@ -0,0 +1,17 @@
+API Reference
+=============
+
+.. automodule:: powersensor_local
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+__________
+
+.. autosummary::
+   :toctree: submodules
+   :recursive:
+
+    devices
+    listener

docs/source/api.rst

@@ -0,0 +1,87 @@
+"""Sphinx configuration file for powersensor_local documentation."""
+
+import sys
+from pathlib import Path
+
+# Add the package to the Python path
+project_root = Path(__file__).parent.parent.parent
+sys.path.insert(0, str(project_root / "src"))
+print(project_root)
+
+# Project information
+project = "powersensor_local"
+copyright = "2025, DiUS"
+author = "Powersensor Team!"
+
+html_favicon = "_static/powersensor-logo.png"
+html_logo = "_static/powersensor-logo.png"
+
+# The full version, including alpha/beta/rc tags
+try:
+    from powersensor_local import __version__
+    release = __version__
+except ImportError:
+    release = "0.1.0"
+
+version = ".".join(release.split(".")[:2])
+
+# Extensions
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "sphinx_autodoc_typehints",
+    "sphinx.ext.autosummary"
+]
+
+# Napoleon settings (for Google and NumPy style docstrings)
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+
+# Autodoc settings
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
+}
+
+# Intersphinx mapping
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}
+
+# HTML theme
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+html_css_files = []
+
+
+# Output file base name for HTML help builder
+htmlhelp_basename = "powersensor_localdoc"
+
+# Options for LaTeX output
+latex_elements = {}
+latex_documents = [
+    ("index", "powersensor_local.tex", "powersensor_local Documentation", "Your Name", "manual"),
+]
+
+# Options for manual page output
+man_pages = [
+    ("index", "powersensor_local", "powersensor_local Documentation", [author], 1)
+]
+
+# Options for Texinfo output
+texinfo_documents = [
+    (
+        "index",
+        "powersensor_local",
+        "powersensor_local Documentation",
+        author,
+        "powersensor_local",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]

docs/source/conf.py

@@ -0,0 +1,38 @@
+Contributing
+============
+
+We welcome contributions! Here's how you can help:
+
+Development Setup
+-----------------
+
+1. Fork the repository
+2. Clone your fork:
+
+   .. code-block:: bash
+
+      git clone https://github.com/yourusername/powersensor_local.git
+
+3. Install development dependencies:
+
+   .. code-block:: bash
+
+      pip install -e ".[docs]"
+
+
+Building Documentation
+----------------------
+
+.. code-block:: bash
+
+   cd docs
+   make html
+
+The documentation will be built in `docs/build/html/`.
+
+Submitting Changes
+------------------
+
+1. Create a new branch for your changes
+2. Make your changes and add tests
+3. Submit a pull request

docs/source/contributing.rst

@@ -0,0 +1,18 @@
+Welcome to powersensor_local's documentation!
+=================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   usage
+   api
+   contributing
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/index.rst

@@ -0,0 +1,27 @@
+Installation
+============
+
+From PyPI
+---------
+
+.. code-block:: bash
+
+   pip install powersensor_local
+
+From Source
+-----------
+
+.. code-block:: bash
+
+   git clone https://github.com/yourusername/powersensor_local.git
+   cd powersensor_local
+   pip install -e .
+
+Development Installation
+------------------------
+
+.. code-block:: bash
+
+   git clone https://github.com/yourusername/powersensor_local.git
+   cd powersensor_local
+   pip install -e ".[docs]"

docs/source/installation.rst

@@ -0,0 +1,18 @@
+Usage
+=====
+
+Basic Usage
+-----------
+
+Here's a simple example of how to use powersensor_local:
+
+.. code-block:: python
+
+   import powersensor_local
+
+   # Add your usage examples here
+
+Advanced Usage
+--------------
+
+More detailed examples and advanced features will be documented here.