86 lines
2.2 KiB
Plaintext
86 lines
2.2 KiB
Plaintext
local record Property
|
|
base_url: string
|
|
index_uri: string
|
|
|
|
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
|
|
-- with what works the best first.
|
|
ignored_modules: { string }
|
|
end
|
|
|
|
local property: Property = {
|
|
-- base_url = "https://awesomewm.org/apidoc",
|
|
-- base_url = "file:///usr/share/doc/awesome/doc",
|
|
base_url = "file:///home/aireone/documents/prog/awesome/build/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",
|
|
"theme.lua",
|
|
|
|
-- Utility libraries
|
|
"gears.debug",
|
|
"gears.filesystem",
|
|
"gears.geometry",
|
|
"gears.math",
|
|
"gears.object",
|
|
"gears.protected_call",
|
|
"gears.sort",
|
|
"gears.string",
|
|
"gears.table",
|
|
"gears.wallpaper",
|
|
|
|
-- Theme related libraries
|
|
"beautiful",
|
|
"gears.color",
|
|
"gears.shape",
|
|
|
|
-- Classes
|
|
"awful.widget.common",
|
|
"gears.cache",
|
|
"gears.matrix",
|
|
"menubar.icon_theme",
|
|
"menubar.index_theme",
|
|
"signals",
|
|
"wibox.drawable",
|
|
"wibox.hierarchy",
|
|
"wibox.widget.base",
|
|
"xproperties",
|
|
|
|
-- Documentation
|
|
"Authors",
|
|
"Readme",
|
|
"Contributing",
|
|
"The Widget system",
|
|
"Creating new widget",
|
|
"Default configuration file documentation",
|
|
"Change Awesome appearance",
|
|
"My first Awesome",
|
|
"The AwesomeWM client layout system",
|
|
"Startup options",
|
|
"Building and Testing",
|
|
"Using Cairo and LGI",
|
|
"Tips for upgrading your configuration",
|
|
"NEWS",
|
|
"FAQ",
|
|
}
|
|
}
|
|
|
|
return property
|