d00ac0be93
doc: Add a widget, container and layout section to the index.
2019-06-08 17:49:14 -04:00
6a2b8abe11
doc: Do not mess with the <a> in the deprecated definiton.
...
It worked fine for the table in the header, but the name is also used in
the "main" documentation below. This caused the while text to be within
the "<a>" section.
2019-06-08 17:49:14 -04:00
c0e8660ca0
doc: Display the `Parameters:` <h3> in the doc.
...
It was displayed for most sections, but not the functions. This is
problem when the doc already contains a bullet list just before the
parameter section. The two looked as if they were a single list.
2019-06-08 17:49:14 -04:00
89a02ac6cd
doc: Standardize the function name.
...
There was some issues like `gears.shape.circle` being called
`module.circle`.
There is also a disparity between how the constructor and "normal"
functions are called.
This commit attempts to force everything to have the full module name.
2019-06-08 17:49:14 -04:00
d92fda78c4
doc: Cleanup how methods are rendered in the doc.
...
Previously, there was some `module:foo()` or `gears.object:foo()`
because the doc used the "raw" name and/or, in some undefined and
race condition prone (due to `pairs()` order), the formatted
"classmod" name.
Now, just display `:foo()` and be done with it.
2019-06-08 17:49:14 -04:00
43c851798b
doc: Update the parser for the next commits.
...
Otherwise the CI will fail.
2019-06-08 17:49:14 -04:00
7ff635bde0
Merge pull request #2507 from Elv13/xmas_2k18_1
...
New theme API groundwork
2019-04-18 13:00:58 -04:00
7a31296387
Update NEWS again ( #2750 )
...
Signed-off-by: Uli Schlachter <psychon@znc.in>
2019-04-16 21:26:28 -04:00
1c0eedfe9f
doc: Update the news for this pull request
2019-04-15 15:26:50 -04:00
df0cdbed61
Merge pull request #2600 from Elv13/extract_rules
...
Extract the awful.rules logic into a gears module
2019-04-15 13:28:48 -04:00
28541c8e82
doc: Update the NEWS for the new features added by this pull request.
2019-04-05 21:06:11 -04:00
50d4e8f04b
doc: Add a deprecated property section.
2019-04-05 21:06:11 -04:00
58bafe8ef4
doc: Add a common documentation for for the rule components.
2019-04-05 20:40:53 -04:00
fa801ac441
ldoc: Do not proces the drag_to_tag file
...
It has no public doc. This avoids a warning.
2019-04-05 20:40:53 -04:00
9befa1ec32
ldoc: Add a new "rulecomponent" section.
...
It is going to be used by `awful.rules`, `gears.matcher`,
`naughty.rules` and `selection.rules`.
2019-04-05 20:40:53 -04:00
d694274d64
Update the NEWS
...
Signed-off-by: Uli Schlachter <psychon@znc.in>
2019-03-07 21:44:04 +01:00
a57c79687a
Use xcb-errors library if it is available
...
This library allows to get a human-readable string describing X11
requests, events, and errors. We now use this library to pretty-print
X11 errors if we get any.
To test this code, I added the following two lines to AwesomeWM so that
X11 errors are generated:
xcb_set_input_focus(globalconf.connection, 42, 42, 42);
xcb_randr_set_output_primary(globalconf.connection,
globalconf.screen->root, 42);
Output without xcb-errors:
X error: request=SetInputFocus (major 42, minor 0), error=BadValue (2)
X error: request=(null) (major 140, minor 30), error=(null) (147)
Output with xcb-errors:
X error: request=SetInputFocus (major 42, minor 0), error=Value (2)
X error: request=RandR-SetOutputPrimary (major 140, minor 30), error=RandR-BadOutput (147)
Signed-off-by: Uli Schlachter <psychon@znc.in>
2019-03-03 09:15:29 +01:00
9df77e5c76
naughty: Move the notification object into its own file.
...
Mostly for the documentation, but also as the new base upon which
to build the modular notification GUI.
2019-02-16 15:25:10 -05:00
3f23914626
Start writing NEWS for the next release ( #2624 )
...
Signed-off-by: Uli Schlachter <psychon@znc.in>
2019-02-09 17:35:42 -05:00
2023ed187a
Add xcb-xfixes as a new dependency and initialise it
...
This commit prepares changes in the following commits
Signed-off-by: Uli Schlachter <psychon@znc.in>
2019-02-06 09:21:26 +01:00
0a999c4192
Change the badge URL from travis-ci.org to travis-ci.com ( #2625 )
2019-01-29 11:24:31 +01:00
a80323d2d0
Fix some typos in the NEWS
...
Signed-off-by: Uli Schlachter <psychon@znc.in>
2019-01-28 08:47:20 +01:00
22b6e80cad
Update the NEWS for 4.3
2019-01-26 13:16:22 -05:00
e3c1ecfd40
docs: Better document how widgets work
...
Ref: #1373
2019-01-24 10:58:45 -05:00
aae9b25457
ldoc.ltp: improve HTML title
2019-01-04 22:39:28 +01:00
6792415cef
ldoc: prepare for custom ldoc.ltp
...
ldoc.ltp is copied from ldoc (ldoc/html/ldoc_ltp.lua).
2019-01-04 22:39:28 +01:00
d121780366
doc(readme): add receipts for installing current git master
2019-01-01 18:43:43 +01:00
98be7e88ef
Merge pull request #2483 from actionless/questions-readme
...
doc(readme): add questions section; split issues and contributing; fix apidoc link (in ldoc)
2018-12-17 14:24:24 +00:00
29b2b7138d
doc(readme): add section about IRC
2018-11-19 22:09:46 +01:00
86084690b2
doc(readme): add questions section; split issues and contributing; fix apidoc link (in ldoc)
2018-11-19 22:01:37 +01:00
f0878941ab
doc: Fix c.requests_no_titlebar example
...
Signed-off-by: Sergey Vlasov <sigprof@gmail.com>
2018-11-12 11:48:59 +03:00
da585439ff
docs: update URL for vicious ( #2446 )
...
It has been turned into an organization [1].
1: https://github.com/vicious-widgets/vicious/issues/60
[ci skip]
2018-10-20 15:15:01 -04:00
bb357dd33e
doc: Restore the example width limit to fit in 1024x768.
...
The old stylesheet did this and it forced the examples to be smaller.
This commit restore this limit.
2018-10-12 14:19:25 -04:00
cd6979618f
doc: Update the CSS to support our custom table class
...
Other change:
* Use GitHub style <code> border
* Add support for HTML <kbd> tags
2018-10-12 14:19:25 -04:00
b49f7e22dd
doc: Add an index of valid properties to awful.spawn and awful.rules.
2018-10-12 14:19:25 -04:00
62c95d5fe6
build: Move the meta file parser to an helper module
...
The commit also re-work the build target so if the file are deleted,
then they are created again. Using `file(COPY ...)` and
`file(MAKE_DIRECTORY ...)` as done previously caused some file to be out
of date or not being regenerated at all.
This commit also fixes some broken target that depended on `file(` and
`configure_file` CMake command not being part of any target.
Fix #2342
2018-10-12 14:18:32 -04:00
90b17bdc09
awful.rules: Add proper documentation to the extra client properties.
...
Until now there wasn't much documentation available about how to use
these properties. With the new work on `awful.spawn` that rely more and
more on `awful.rules` integration, it is worth fixing.
This commit add a new documentation section and a future commit will
aggregate them to generate an index.
2018-10-10 01:58:18 -04:00
768184d152
Merge pull request #2368 from psychon/motif_hints
...
Add c.requests_no_titlebar based on motif hints
2018-10-06 22:00:03 -04:00
3fe5798a97
ldoc: Add a @sourcefunction section.
...
It will be used by features introduced in the next commit.
2018-08-27 00:03:22 -04:00
45430daf7f
rc.lua: Move Motif hints example to generated docs
...
Signed-off-by: Uli Schlachter <psychon@znc.in>
2018-08-26 19:26:19 +02:00
3792a17c2f
ldoc: Add a "filter" section for the taglist and tasklist
2018-08-18 15:49:05 -04:00
f11c0b47b9
doc: Remove capi.keygrabber from the official doc
...
`awful.keygrabber` should be the only one used directly.
2018-08-06 19:03:25 -04:00
3876b18240
doc: Add missing C-object documentation and fix some papercuts.
...
Ref: https://github.com/awesomeWM/awesome/issues/1373
2018-07-25 18:26:11 -04:00
4bd5b1940d
feat(themes; beautiful): add partial support for GTK+3 themes ( #2129 )
2018-06-26 10:43:20 -04:00
f234dcabf6
doc: Add `[deprecated]` after some function names.
...
It use a little XSS-ish HTML tag injection, but it works
2018-05-28 14:11:41 -04:00
0a2b05dfbb
doc: Use the newer LDoc ability to use special handler for objects types
...
The `@signal` and `@property` are now correctly rendered. The need for
the extra `.` in front of the signal is no longer needed.
2018-05-28 14:11:41 -04:00
d9cc56538f
build: man pages: use asciidoctor instead of asciidoc ( #2234 )
2018-04-04 11:28:50 +02:00
98e59225d7
chore(ldoc: css): return bullets style for unordered list items
2018-03-20 17:50:39 +00:00
bdbc11e7df
style(ldoc: css): apply some manual code formatting
2018-03-20 17:50:39 +00:00
d5d46a4373
fixup! chore(ldoc: css): new style for the tables
2018-03-20 17:50:39 +00:00
Emmanuel Lepage Vallee
Uli Schlachter
Uli Schlachter
Daniel Hahler
actionless
mergify[bot]
Sergey Vlasov
Daniel Hahler
Joseph Herlant