Commit graph

25 commits

Author SHA1 Message Date
Daniel Hahler
6d323e7c04 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-26 00:45:38 +02:00
Daniel Hahler
3fb83ba9b5 README: add reference to online doc, small improvements
Closes https://github.com/awesomeWM/awesome/pull/345.
2015-07-25 15:12:48 +02:00
Daniel Hahler
917965483d doc: improve docs/02-contributing.md 2015-07-12 17:42:53 +02:00
Daniel Hahler
b7e2508144 docs: include lib/awful/ewmh.lua 2015-06-25 06:47:39 +02:00
Julian Wollrath
26f15a13f3 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-06-19 23:13:31 +02:00
Julian Wollrath
6cc7be512c Remove the *.in from all files.
Signed-off-b: Julian Wollrath <jwollrath@web.de>
2015-06-19 22:33:32 +02:00
Daniel Hahler
c2ee98b69c doc: improve doc for key.key and awful.key 2015-06-19 20:59:14 +02:00
Daniel Hahler
76fc6b3306 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-15 01:58:45 +02:00
Daniel Hahler
9b9334976a Add config for Travis CI
This builds and installs awesome (which runs its checks) and displays
--version.

 - Build libxcb-cursor-dev and lua-lgi manually.
 - A lot of dependencies are installed manually from Git or luarocks.
 - Include Travis status in README.

Closes https://github.com/awesomeWM/awesome/pull/208.
2015-04-26 04:01:32 +02:00
Aleksey Fedotov
996f6785a8 xkb: implementation of keyboard layout switched
This patch provides functions to get/set current keyboard layout.

Current implementation doesn't support any configuration of layout,
it's a merely a layout indicator and switcher, however layout
configuration can be set by tools like setxkbmap or by any third-party
tools.
2015-03-03 00:33:16 +03:00
Julian Wollrath
ca89f0f311 Use LDoc commands to mark parameters as optional in the docs.
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:15 +01:00
Julian Wollrath
781f0be520 Drop empty module descriptions from the docs. 2015-02-28 23:14:15 +01:00
Julian Wollrath
fcadebb8ae Fix Markdown issues with contributing guide.
Inline code blocks (`code`) apparently can not be extended about
multiple lines.

Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:15 +01:00
Daniel Hahler
65ad83ac30 docs: ignore awful/widget/init.lua, not common 2015-02-28 23:14:14 +01:00
Julian Wollrath
f66b52463d Convert HTML to Markdown. 2015-02-28 23:14:14 +01:00
Daniel Hahler
12f8be1824 docs/02-contributing.md: fix/improve Patches section 2015-02-28 23:14:14 +01:00
Daniel Hahler
74f2596ae7 docs/02-contributing.md: fix whitespace / formatting 2015-02-28 23:14:14 +01:00
Julian Wollrath
a65affe9d0 Add section about LDoc in the contributing guide. 2015-02-28 23:14:14 +01:00
Julian Wollrath
5b69d8c5dd Fix spelling in the contributing guide. 2015-02-28 23:14:14 +01:00
Julian Wollrath
0b65459e14 Make screen a class in the docs.
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
Daniel Hahler
a533097cfd doc: fix typos and add type information to screen module 2015-02-28 23:14:13 +01:00
Julian Wollrath
c7709e39d2 Fixup display of e-mail adresses in the docs.
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
Julian Wollrath
4d76967397 Beautify docs a little bit.
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
Julian Wollrath
ce0a2d4749 Add missing changes due to docs-overhaul.
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:12 +01:00
Ignas Anikevicius (gns_ank)
b96b3ef31c 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>
2015-02-28 23:14:12 +01:00