mirror of
https://github.com/awesomeWM/awesome
synced 2024-11-17 07:47:41 +01:00
57 lines
1.4 KiB
Lua
57 lines
1.4 KiB
Lua
-- Configuration file for ldoc
|
|
|
|
project='awesome'
|
|
title='awesome API documentation'
|
|
description='highly configurable X window manager'
|
|
|
|
-- More on it: https://github.com/stevedonovan/LDoc/blob/master/doc/doc.md#markdown-support
|
|
format='discount'
|
|
dir='../doc'
|
|
|
|
-- Make the docs prettier
|
|
pretty='lua'
|
|
style="!pale"
|
|
backtick_references=true
|
|
merge=true
|
|
use_markdown_titles = true
|
|
wrap=true
|
|
topics={
|
|
'00-authors.md',
|
|
'01-readme.md',
|
|
'02-contributing.md',
|
|
}
|
|
|
|
-- Setup @client to be an alias for "@tparam client.client"
|
|
tparam_alias('client', 'client.client')
|
|
tparam_alias('tag', 'tag')
|
|
-- Should be default, but is not. Sets up "@tab" => "@tparam table".
|
|
tparam_alias('tab', 'table')
|
|
|
|
-- More fitting section names
|
|
kind_names={topic='Documentation',module='Libraries'}
|
|
|
|
-- Sort modules alphabetically
|
|
sort_modules=true
|
|
|
|
file = {
|
|
-- LUA libraries
|
|
'capi/',
|
|
'../lib/',
|
|
exclude = {
|
|
-- exclude these modules, as they do not contain any written
|
|
-- documentation
|
|
'../lib/awful/autofocus.lua',
|
|
'../lib/awful/dbus.lua',
|
|
'../lib/awful/ewmh.lua',
|
|
'../lib/awful/remote.lua',
|
|
'../lib/awful/startup_notification.lua',
|
|
|
|
-- Ignore some parts of the widget library
|
|
'../lib/awful/widget/common.lua',
|
|
|
|
-- exclude layout, but we need an extra bit of documentation elsewhere.
|
|
'../lib/awful/layout/suit/'
|
|
}
|
|
}
|
|
|
|
-- vim: filetype=lua
|