Commit Graph

10922 Commits

Author SHA1 Message Date
Alex 76edd69587
Update apidoc.yml
Remove write permission as not needed
2022-09-20 20:13:12 +01:00
Alex 00b1ad5b45 build: harden apidoc.yml permissions
Signed-off-by: Alex <aleksandrosansan@gmail.com>
2022-09-20 14:24:00 +02:00
Alex b602d42073 build: harden main.yml permissions
Signed-off-by: Alex <aleksandrosansan@gmail.com>
2022-09-20 14:21:14 +02:00
Aire-One 8d5c74fae3 fix(ldoc): set `format` to "markdown" (#3500)
The CI currently doesn't install (correctly?) the "discount" formatter,
so ldoc fallbacks to the default "markdown" formatter. However, if we
try to install the discount or lua-discount, the doc rendering is
slightly different from what we currently have.

All of this was already mentioned in the issue "Generate apidoc doesn't
use the discount markdown formatter #3500".

This change removes the configuration in the `config.ld` file, so we
don't have the "format: using built-in markdown" message any longer in
in the CI logs.

Note that I also removed the lua-discount installation from the
`apidoc.yml` workflow, since it wasn't working. (I guess it installs the lua
package for a different version of lua than the one used by ldoc)
2022-09-18 18:40:52 +02:00
Aire-One db5ade48e4 doc(awful.titlebar): fix ldoc WARN 2022-09-18 18:22:52 +02:00
Aire-One 941bb72fa2 doc(awful.keygrabber): fix ldoc WARN 2022-09-18 18:22:02 +02:00
Actionless Loveless bde785ee64
fix(ruled: client: matching_rules): regression after 75019c3f6f (#3694) 2022-09-15 23:44:48 -07:00
Beniamin Kalinowski 6ca2fbb31c
Fixing warnings in the documentation build. (#3687) 2022-09-10 15:16:14 -07:00
Emmanuel Lepage Vallée 5ea654ee6b
Merge pull request #3686 from Elv13/textbox_upgrades
Textbox upgrades
2022-09-10 15:15:47 -07:00
Emmanuel Lepage Vallee a4b3506e15 doc: Mentions the property renaming and Pango version in NEWS.md 2022-09-06 16:11:17 -07:00
Emmanuel Lepage Vallee 88c65a71dd textbox: Rename `align` to `halign`.
`halign` is used in multiple place in the API. Once upon a time,
Awesome only supported horizontal widgets, but this era has long
passed.

Fix #3640
2022-09-06 16:11:04 -07:00
Emmanuel Lepage Vallee b16505733a tests: Add more textbox tests. 2022-09-06 16:09:26 -07:00
Emmanuel Lepage Vallee d7f6410e09 textbox: Add 3 properties.
The textbox API reflects the Pango layout API circa 2011, time to
bring this to 2022. This adds:

 * indent
 * justify
 * line_spacing_factor

It doesn't add `spacing` because it doesn't seem to do anything.
It also doesn't add the `is_*` methods to know if the text wraps
or ellipsize. We could, but nobody asked for them. The line spacing
is a feature request from Posix on Discord.
2022-09-06 16:09:26 -07:00
tocic 0f99647c38
doc: Fix typos (#3689)
* doc: Fix typos

* doc: Fix an additional typo

Co-authored-by: Lucas Schwiderski <4508454+sclu1034@users.noreply.github.com>

Co-authored-by: Lucas Schwiderski <4508454+sclu1034@users.noreply.github.com>
2022-09-06 15:43:36 -07:00
Tonda Fischer c8d4f878a0
#3539: Make tool tips indicate the action that a click will acheive (#3657)
* #3539: Make tool tips indicate the action that a click will achieve.
2022-09-03 15:31:24 -07:00
Emmanuel Lepage Vallée 9b1246af3d
Merge pull request #3676 from Elv13/v44_doc_polishing
Implement documentation linting.
2022-08-30 23:26:12 -07:00
Emmanuel Lepage Vallee 82a5fb6030 doc: Do not document the 16bit max widget size.
As pointed out by @aire-one, it does not provide much value.
2022-08-29 22:54:09 -07:00
Emmanuel Lepage Vallee 328551d479 doc: Fix the UML template luacheck issues 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 3c0d5b606f doc: Fix issues found by @aire-one. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee fc95f43bde doc: Add logging to _postprocess.lua.
Try to find why it works locally, but not on GitHub.
2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 4ff17396b6 root: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 1998fe8609 objects.tag: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee f30800ec4e objects.screen: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee c60e7002e0 objects.drawable: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 34f936b646 objects.client: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee b662bf772f mouse: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee a18b40e12b wibox.widget.textclock: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 1eda8cdf93 wibox.widget.textbox: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 642fa3b66b wibox.widget.systray: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 5367513609 wibox.widget.slider: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 79496e9acc wibox.widget.separator: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee f9f04866b8 wibox.widget.progressbar: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee e63d867523 wibox.widget.piechart: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 95cd45942a wibox.widget.imagebox: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 8e16dc4412 wibox.widget.graph: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee ff9c89d005 wibox.widget.checkbox: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 1b726985de wibox.widget.calendar: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 1259c3ccc6 wibox.widget.base: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 926f0ff22f wibox.layout.stack: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee d05fc5dc8f wibox.layout.ratio: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee c963b16f90 wibox.layout.grid: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 13b792e42e wibox.layout.flex: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 285a8b23ff wibox.layout.fixed: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 1fa30c3195 wibox.layout.align: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 2e41211772 wibox.container.tile: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 4c06aaab4f wibox.container.scroll: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 1dafd25d93 wibox.container.rotate: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 6c84e83ccf wibox.container.radialprogressbar: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee f0482485fa wibox.container.place: Update the property documentation. 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee bdec7eb516 wibox.container.mirror: Update the property documentation. 2022-08-29 22:49:47 -07:00