Commit Graph

5 Commits

Author SHA1 Message Date
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
Julian Wollrath 781f0be520 Drop empty module descriptions from the docs. 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 4d76967397 Beautify docs a little bit.
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +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