doc: Document custom directive in python script

This commit is contained in:
patrick96 2023-04-03 14:46:18 +02:00 committed by Patrick Ziegler
parent 44b5f87884
commit f3c911991c

View File

@ -251,6 +251,15 @@ suppress_warnings = ['app.add_directive']
def setup(app): 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( app.add_object_type(
'poly-setting', 'poly-setting',
'poly-setting', 'poly-setting',