run(property): add `capi_modules` list

This commit is contained in:
Aire-One 2022-12-22 21:19:00 +01:00
parent 3bd162b74c
commit ff60093bbe
1 changed files with 12 additions and 0 deletions

View File

@ -4,6 +4,12 @@ local record Property
out_directory: string
--- Pages with modules from the C API.
-- These pages contains definitions for both, the global C API and the
-- `awful` library. We have to manage them separately, because the global C
-- API should be part of the global_en_def.
capi_modules: { string }
--- Pages from the navigation menu to ignore.
-- Sets to ignore documentations and sample file. I also added libraries with
-- low quality API documentation, I'll probably work on them later, lets start
@ -16,6 +22,12 @@ local property: Property = {
base_url = "file:///usr/share/doc/awesome/doc",
index_uri = "/index.html",
out_directory = "generated",
capi_modules = {
"awesome",
"client and awful.client",
"screen and awful.screen",
"tag and awful.tag",
},
ignored_modules = {
-- Sample files
"rc.lua",