From f3c911991c418632e64b01577a6fdbab3b2f14a8 Mon Sep 17 00:00:00 2001
From: patrick96 <p.ziegler96@gmail.com>
Date: Mon, 3 Apr 2023 14:46:18 +0200
Subject: [PATCH] doc: Document custom directive in python script

---
 doc/conf.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/conf.py b/doc/conf.py
index d1972fd4..ebe9b43b 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -251,6 +251,15 @@ suppress_warnings = ['app.add_directive']
 
 
 def setup(app):
+
+    # Adds a new directive for document a polybar config setting
+    # Inside goes the description of the option as well as custom roles to
+    # document the type, default value, etc:
+    # .. poly-setting:: NAME
+    #
+    #   Description
+    #   :type: ...
+    #   :default: ...
     app.add_object_type(
         'poly-setting',
         'poly-setting',