doc: Document custom directive in python script
This commit is contained in:
parent
44b5f87884
commit
f3c911991c
@ -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',
|
||||||
|
Loading…
Reference in New Issue
Block a user