Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
awesome/docs/config.ld

91 lines
2.7 KiB
Plaintext
Raw Normal View History

Use LDoc instead of Luadoc (FS#1006) Since we are no longer using module(), luadoc no longer understands our modules. With this commit we use LDoc instead which seems more modern. Signed-off-by: Uli Schlachter <psychon@znc.in>
2012-11-19 14:57:47 +01:00
-- Configuration file for ldoc
Docs: change the style of documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-25 14:35:44 +02:00
Use LDoc instead of Luadoc (FS#1006) Since we are no longer using module(), luadoc no longer understands our modules. With this commit we use LDoc instead which seems more modern. Signed-off-by: Uli Schlachter <psychon@znc.in>
2012-11-19 14:57:47 +01:00
project='awesome'
title='awesome API documentation'
doc: LDoc config (version in desc); improve 02-contributing.md Adding @AWESOME_VERSION@ to the LDoc description is useful to have on the index page. While at it, it makes the description more verbose/correct. For docs/02-contributing.md, it lists the current aliases for typed parameters, prefers/mentions `@tparam` and `@treturn` only, and fixes some minor wording. Closes #262.
2015-06-14 02:35:10 +02:00
description='API documentation for awesome, a highly configurable X window manager (version @AWESOME_VERSION@).'
Docs: Use LDoc markdown support, exclude files. Use markdown support, which is bundled together with LDoc. Also, add a macro for the client type, which will simplify parameter definitions. With this we can write `@client` instead of `@tparam client` in order to denote that the parameter needs to be a client structure. This simplifies `awful.client` module. This also excludes some of the `.lua` files from generating the documentation, because some of the files do not contain useful information or any public functions at all. This make the docs easier to navigate. Remove layouts from documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-19 11:48:23 +02:00
-- More on it: https://github.com/stevedonovan/LDoc/blob/master/doc/doc.md#markdown-support
Docs: Move all docs to a `docs` folder. This moves all of the documentation into a separate folder, which keeps everything in one place and avoids unnecessary clutter. This will pay off when proper guides are written for various aspects of using awesome or contributing to it. This also updates the building system, so that the docs are properly generated with new directories. Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-26 21:26:52 +02:00
format='discount'
dir='../doc'
Docs: Use LDoc markdown support, exclude files. Use markdown support, which is bundled together with LDoc. Also, add a macro for the client type, which will simplify parameter definitions. With this we can write `@client` instead of `@tparam client` in order to denote that the parameter needs to be a client structure. This simplifies `awful.client` module. This also excludes some of the `.lua` files from generating the documentation, because some of the files do not contain useful information or any public functions at all. This make the docs easier to navigate. Remove layouts from documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-19 11:48:23 +02:00
-- Make the docs prettier
pretty='lua'
Docs: change the style of documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-25 14:35:44 +02:00
style="!pale"
Docs: Use LDoc markdown support, exclude files. Use markdown support, which is bundled together with LDoc. Also, add a macro for the client type, which will simplify parameter definitions. With this we can write `@client` instead of `@tparam client` in order to denote that the parameter needs to be a client structure. This simplifies `awful.client` module. This also excludes some of the `.lua` files from generating the documentation, because some of the files do not contain useful information or any public functions at all. This make the docs easier to navigate. Remove layouts from documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-19 11:48:23 +02:00
backtick_references=true
merge=true
doc: LDoc config (version in desc); improve 02-contributing.md Adding @AWESOME_VERSION@ to the LDoc description is useful to have on the index page. While at it, it makes the description more verbose/correct. For docs/02-contributing.md, it lists the current aliases for typed parameters, prefers/mentions `@tparam` and `@treturn` only, and fixes some minor wording. Closes #262.
2015-06-14 02:35:10 +02:00
use_markdown_titles=true
Beautify docs a little bit. Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-20 15:24:26 +01:00
wrap=true
Docs: update config.ld.in Include more files in order to generate the docs. Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-24 23:25:12 +02:00
topics={
Docs: Move all docs to a `docs` folder. This moves all of the documentation into a separate folder, which keeps everything in one place and avoids unnecessary clutter. This will pay off when proper guides are written for various aspects of using awesome or contributing to it. This also updates the building system, so that the docs are properly generated with new directories. Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-26 21:26:52 +02:00
'00-authors.md',
'01-readme.md',
'02-contributing.md',
doc: Add layout system documentation
2016-02-10 07:07:47 +01:00
'03-declarative-layout.md',
doc: Move the new widget documentation to a new file This will help with discoverability
2016-02-10 07:21:29 +01:00
'04-new-widgets.md',
Docs: update config.ld.in Include more files in order to generate the docs. Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-24 23:25:12 +02:00
}
doc: config.ld: setup @client alias, and use it It also adds the "@tab" alias, which did not work for me, but should be the default?!
2015-02-15 22:33:23 +01:00
doc: distinguish between client.object and client.class Instead of `client.client`, the client object is now referred to as `client.object` and the client class as `client.class`. This moves the documentation of `client.focus` to the class. Closes https://github.com/awesomeWM/awesome/pull/349.
2015-07-25 00:00:07 +02:00
-- Setup @client to be an alias for "@tparam client.object"
tparam_alias('client', 'client.object')
Docs: Use LDoc markdown support, exclude files. Use markdown support, which is bundled together with LDoc. Also, add a macro for the client type, which will simplify parameter definitions. With this we can write `@client` instead of `@tparam client` in order to denote that the parameter needs to be a client structure. This simplifies `awful.client` module. This also excludes some of the `.lua` files from generating the documentation, because some of the files do not contain useful information or any public functions at all. This make the docs easier to navigate. Remove layouts from documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-19 11:48:23 +02:00
tparam_alias('tag', 'tag')
doc: config.ld: setup @client alias, and use it It also adds the "@tab" alias, which did not work for me, but should be the default?!
2015-02-15 22:33:23 +01:00
-- Should be default, but is not. Sets up "@tab" => "@tparam table".
tparam_alias('tab', 'table')
documentation: Add various tags and fix section order. Previously, the `Signals` section was shown before the `Functions`. This was confusing and different from other framework documentation. It partially work. Not all ldoc output display the functions at the top, but some does. Previously, none did. This commit also add 3 new sections: * property: For object properties, replacing the "fields" table from the current documentations. * deprecated: For deprecated methods * beautiful: For widgets theme options
2016-04-03 08:59:50 +02:00
-- Hack to get the functions and method on top of the signals and properties
new_type("function", "Functions")
-- Documentation for objects properties
new_type("property", "Object properties", false, "Type")
Document C API directly in the C source code v2: Add available signals to the docs. Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-27 00:24:23 +01:00
-- New type for signals
new_type("signal", "Signals", false, "Arguments")
documentation: Add various tags and fix section order. Previously, the `Signals` section was shown before the `Functions`. This was confusing and different from other framework documentation. It partially work. Not all ldoc output display the functions at the top, but some does. Previously, none did. This commit also add 3 new sections: * property: For object properties, replacing the "fields" table from the current documentations. * deprecated: For deprecated methods * beautiful: For widgets theme options
2016-04-03 08:59:50 +02:00
-- Allow objects to define a set of beautiful properties affecting them
new_type("beautiful", "Theme variables", false, "Type")
-- Put deprecated methods in their own section
new_type("deprecated", "Deprecated functions", false, "param")
-- For the legacy stateless layout related functions
new_type("legacylayout", "Layout related functions", false, "param")
Docs: Use LDoc markdown support, exclude files. Use markdown support, which is bundled together with LDoc. Also, add a macro for the client type, which will simplify parameter definitions. With this we can write `@client` instead of `@tparam client` in order to denote that the parameter needs to be a client structure. This simplifies `awful.client` module. This also excludes some of the `.lua` files from generating the documentation, because some of the files do not contain useful information or any public functions at all. This make the docs easier to navigate. Remove layouts from documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-19 11:48:23 +02:00
Beautify docs a little bit. Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-20 15:24:26 +01:00
-- More fitting section names
doc: LDoc config (version in desc); improve 02-contributing.md Adding @AWESOME_VERSION@ to the LDoc description is useful to have on the index page. While at it, it makes the description more verbose/correct. For docs/02-contributing.md, it lists the current aliases for typed parameters, prefers/mentions `@tparam` and `@treturn` only, and fixes some minor wording. Closes #262.
2015-06-14 02:35:10 +02:00
kind_names={topic='Documentation', module='Libraries'}
Beautify docs a little bit. Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-20 15:24:26 +01:00
-- Sort modules alphabetically
sort_modules=true
Docs: Use LDoc markdown support, exclude files. Use markdown support, which is bundled together with LDoc. Also, add a macro for the client type, which will simplify parameter definitions. With this we can write `@client` instead of `@tparam client` in order to denote that the parameter needs to be a client structure. This simplifies `awful.client` module. This also excludes some of the `.lua` files from generating the documentation, because some of the files do not contain useful information or any public functions at all. This make the docs easier to navigate. Remove layouts from documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-19 11:48:23 +02:00
file = {
Document C API directly in the C source code v2: Add available signals to the docs. Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-27 00:24:23 +01:00
-- C parts of libraries
'../dbus.c',
'../keygrabber.c',
'../luaa.c',
'../mouse.c',
'../mousegrabber.c',
'../root.c',
'../selection.c',
'../spawn.c',
'../xkb.c',
'../common/luaobject.c',
'../objects/',
Docs: update config.ld.in Include more files in order to generate the docs. Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-24 23:25:12 +02:00
-- LUA libraries
Docs: Move all docs to a `docs` folder. This moves all of the documentation into a separate folder, which keeps everything in one place and avoids unnecessary clutter. This will pay off when proper guides are written for various aspects of using awesome or contributing to it. This also updates the building system, so that the docs are properly generated with new directories. Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-26 21:26:52 +02:00
'../lib/',
documentation: Merge awful.client and client pages ldoc doesn't allow to specify fields from class "A" into class "B", so the only solution is to merge the 2. Also, one of the most common complain on IRC since Awesome 3.0 is that the client API doc is confusing since it is in 2 different files. Also restore the `awful.client` doc link, point to `client` This will avoid broken links.
2016-03-31 08:36:44 +02:00
-- Old APIs the user should not longer use directly
'../../docs/aliases/awful_client.lua',
awful.tag: Merge API documentation with tag
2016-04-12 04:53:22 +02:00
'../../docs/aliases/awful_screen.lua',
'../../docs/aliases/awful_tag.lua',
Docs: Use LDoc markdown support, exclude files. Use markdown support, which is bundled together with LDoc. Also, add a macro for the client type, which will simplify parameter definitions. With this we can write `@client` instead of `@tparam client` in order to denote that the parameter needs to be a client structure. This simplifies `awful.client` module. This also excludes some of the `.lua` files from generating the documentation, because some of the files do not contain useful information or any public functions at all. This make the docs easier to navigate. Remove layouts from documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-19 11:48:23 +02:00
exclude = {
-- exclude these modules, as they do not contain any written
-- documentation
Docs: Move all docs to a `docs` folder. This moves all of the documentation into a separate folder, which keeps everything in one place and avoids unnecessary clutter. This will pay off when proper guides are written for various aspects of using awesome or contributing to it. This also updates the building system, so that the docs are properly generated with new directories. Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-26 21:26:52 +02:00
'../lib/awful/autofocus.lua',
'../lib/awful/dbus.lua',
Drop empty module descriptions from the docs.
2015-02-26 17:48:10 +01:00
'../lib/awful/init.lua',
Docs: Move all docs to a `docs` folder. This moves all of the documentation into a separate folder, which keeps everything in one place and avoids unnecessary clutter. This will pay off when proper guides are written for various aspects of using awesome or contributing to it. This also updates the building system, so that the docs are properly generated with new directories. Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-26 21:26:52 +02:00
'../lib/awful/remote.lua',
'../lib/awful/startup_notification.lua',
Drop empty module descriptions from the docs.
2015-02-26 17:48:10 +01:00
'../lib/gears/init.lua',
'../lib/wibox/layout/init.lua',
'../lib/wibox/widget/init.lua',
Docs: Use LDoc markdown support, exclude files. Use markdown support, which is bundled together with LDoc. Also, add a macro for the client type, which will simplify parameter definitions. With this we can write `@client` instead of `@tparam client` in order to denote that the parameter needs to be a client structure. This simplifies `awful.client` module. This also excludes some of the `.lua` files from generating the documentation, because some of the files do not contain useful information or any public functions at all. This make the docs easier to navigate. Remove layouts from documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-19 11:48:23 +02:00
Docs: Ignore awful.widget.common Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-20 23:52:08 +02:00
-- Ignore some parts of the widget library
docs: ignore awful/widget/init.lua, not common
2015-02-26 16:05:47 +01:00
'../lib/awful/widget/init.lua',
Docs: Ignore awful.widget.common Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-20 23:52:08 +02:00
Docs: Use LDoc markdown support, exclude files. Use markdown support, which is bundled together with LDoc. Also, add a macro for the client type, which will simplify parameter definitions. With this we can write `@client` instead of `@tparam client` in order to denote that the parameter needs to be a client structure. This simplifies `awful.client` module. This also excludes some of the `.lua` files from generating the documentation, because some of the files do not contain useful information or any public functions at all. This make the docs easier to navigate. Remove layouts from documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-19 11:48:23 +02:00
-- exclude layout, but we need an extra bit of documentation elsewhere.
Docs: Move all docs to a `docs` folder. This moves all of the documentation into a separate folder, which keeps everything in one place and avoids unnecessary clutter. This will pay off when proper guides are written for various aspects of using awesome or contributing to it. This also updates the building system, so that the docs are properly generated with new directories. Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-26 21:26:52 +02:00
'../lib/awful/layout/suit/'
Docs: Use LDoc markdown support, exclude files. Use markdown support, which is bundled together with LDoc. Also, add a macro for the client type, which will simplify parameter definitions. With this we can write `@client` instead of `@tparam client` in order to denote that the parameter needs to be a client structure. This simplifies `awful.client` module. This also excludes some of the `.lua` files from generating the documentation, because some of the files do not contain useful information or any public functions at all. This make the docs easier to navigate. Remove layouts from documentation Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2014-05-19 11:48:23 +02:00
}
}
Add the right vim modeline to all lua files Signed-off-by: Uli Schlachter <psychon@znc.in>
2015-12-12 17:42:33 +01:00
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80