Change docs theme

.github/workflows/docs.yml

@@ -3,6 +3,10 @@ name: Docs
 on:
   release:
     types: [ published ]
+  push:
+    branches:
+      - docs
+      - main
   workflow_dispatch:
 
 jobs:
@@ -23,6 +27,12 @@ jobs:
           poetry-version: "1.8.4"
           install-args: --with docs
 
+      - name: Set git credentials
+        id: setup
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+
       - name: Build the docs
         id: build
         run: poetry run mkdocs build

docs/api/index.md

@@ -0,0 +1,12 @@
+# API Reference
+
+The following section describes all the classes and functions available in the library.
+
+## Client
+
+The `Client` class is the main class to interact with the OpenWebNet gateway.
+
+::: pyown.client.Client
+    rendering:
+        show_source: false
+        show_root_heading: true

docs/index.md

@@ -15,6 +15,17 @@ It is used to communicate to a gateway that is connected to the SCS bus where al
 
 The already existent libraries for python are either not maintained or not complete, so I decided to create a new one that is easy to use and completely type annotated.
 
+## Features
+
+- Fully type annotated
+- Asynchronous
+- Easy to use
+
+## Manuals
+
+- API Reference: [API Reference](api/index.md)
+- Official OpenWebNet protocol documentation: [OpenWebNet protocol](https://developer.legrand.com/Documentation/)
+
 ## Disclaimer
 
 - This library is not associated by any means with BTicino or Legrand companies 

mkdocs.yml

@@ -2,9 +2,31 @@ site_name: PyOWN Documentation
 site_url: https://jotonedev.github.io/pyown/
 repo_url: https://github.com/jotonedev/pyown
 
-theme: readthedocs
+theme:
+    name: material
+    palette:
+    - media: "(prefers-color-scheme)"
+      scheme: default
+      primary: indigo
+      accent: indigo
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: indigo
+      accent: indigo
+
 
 plugins:
 - mkdocstrings:
     default_handler: python
+    handlers:
+      python:
+        options:
+          members_order: source
+          separate_signature: true
+          filters: ["!^_"]
+          docstring_options:
+            ignore_init_summary: true
+          merge_init_into_class: true
+          show_signature_annotations: true
+          signature_crossrefs: true