98dd0d6b63
Merge branch 'docs-overhaul'
...
Closes https://github.com/awesomeWM/awesome/pull/146
2015-02-28 23:22:29 +01:00
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
781f0be520
Drop empty module descriptions from the docs.
2015-02-28 23:14:15 +01:00
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
ffa535ca29
doc: fix markup with wibox.widget.textbox:set_markup
2015-02-28 23:14:14 +01:00
1b6564f209
docs: fix HTML / table param with awful/widget/tasklist.lua
2015-02-28 23:14:14 +01:00
65ad83ac30
docs: ignore awful/widget/init.lua, not common
2015-02-28 23:14:14 +01:00
2930c0ab4a
doc: fix for awful.util.geticonpath
2015-02-28 23:14:14 +01:00
f66b52463d
Convert HTML to Markdown.
2015-02-28 23:14:14 +01:00
12f8be1824
docs/02-contributing.md: fix/improve Patches section
2015-02-28 23:14:14 +01:00
74f2596ae7
docs/02-contributing.md: fix whitespace / formatting
2015-02-28 23:14:14 +01:00
a65affe9d0
Add section about LDoc in the contributing guide.
2015-02-28 23:14:14 +01:00
5b69d8c5dd
Fix spelling in the contributing guide.
2015-02-28 23:14:14 +01:00
3a34b49179
Fix LDoc warning.
2015-02-28 23:14:13 +01:00
faa1c74f03
doc: refer to gears.color.create_pattern from set_color
2015-02-28 23:14:13 +01:00
4d7bd19014
Make everything wibox related a class in the docs.
...
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
0b65459e14
Make screen a class in the docs.
...
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
a533097cfd
doc: fix typos and add type information to screen module
2015-02-28 23:14:13 +01:00
f8a3209707
Fix ldoc warning.
...
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
6de9d1e1d5
Make description of awful.mouse.finder readable.
...
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
b16944a654
Fix generation of the docs.
...
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
fd63993b09
Add README.md symlink
...
Ref: https://github.com/awesomeWM/awesome/pull/146#issuecomment-75389767
2015-02-28 23:14:13 +01:00
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
939dab8ba9
Some more doc fixes all over the place.
...
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
668055479e
Convert usage of HTML to markdown.
...
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
4d76967397
Beautify docs a little bit.
...
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
ce0a2d4749
Add missing changes due to docs-overhaul.
...
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:12 +01:00
38e2a47157
Fixup newly introduced whitespace issues.
...
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:12 +01:00
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
6ab86b5d03
Docs: Add local functions to beautiful and naughty
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
ac7377aa3e
Docs: change the style of documentation
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
4b94f05799
Docs: Naughty - mostly done
...
Reorganise the config table, so that we have a single table and the
fields are nested.
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
734cc2f59c
Docs Finish beautiful
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
f12feb0e7d
Docs: update config.ld.in
...
Include more files in order to generate the docs.
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
654b110322
Docs: Fix the header for beautiful
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
d4a4913fd8
Docs: Minor fixes to the README
...
Fix some syntax, so that we have the sections separated by empty lines
(my pandoc syntax plugin was not working correctly without it). Also,
add a sentence on the CONTRIBUTING guide.
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
1f948db685
Docs: merge PATCHES, STYLE, BUGS into CONTRIBUTING.md
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
31bda9e88d
Docs: Ignore awful.widget.common
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
ed0bf91122
Docs: Work on naughty
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
7f8a0787b8
Docs: General work on the awful module.
...
This is basically an initial stab for some modules and some
experimenting with the `@classmod` directive.
For most of the docs only basic transforming was done.
At the moment the tooltip module looks the best.
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00
e4fa6effe2
Docs: Fix headers for the wibox module
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:11 +01:00
00f558ff92
Docs: General work on gears module.
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:11 +01:00
de10f5e4f0
Docs: awful.layouts fixup
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:11 +01:00
9f8e2b1336
Docs: Begin work on awful.client
...
This fixes usage and some and client parameter types.
2015-02-28 23:14:11 +01:00
0f27de8393
Docs: general C API fixes
...
This contains general C API fixes:
1) Remove module declarations in LUA and use the @module directives
2) Fix indentation/usage where necessary
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:11 +01:00
a0051c7dc4
Docs: Start menubar refactoring
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:11 +01:00
20eeb66541
Docs: Start gears.color refactoring
...
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:11 +01:00
f726dcee61
Fix LDoc errors on generating the documentation.
...
This also at the same time ports the documentation to the new `Markdown`
format.
2015-02-28 23:14:11 +01:00
12185a5aae
Docs: Port awful.rules into the new doc format.
...
This converts the old documentation style into the new one to use
markdown instead of HTML in bigger doc blocks. Also, we can use block
comments, which means that writting documentation (and indenting code
blocks) easier.
Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:11 +01:00
400ba86ead
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>
2015-02-28 23:14:11 +01:00
Daniel Hahler
Julian Wollrath
Ignas Anikevicius (gns_ank)