292b657aea
doc: Disable the ldoc optional function parameter mangling.
...
It no longer does `foo(bar[,bar=42])` and will rather do `(foo, bar)`.
This is easier to read and some new user are no familiar with the
optional parameter convention. They copy/paste the mangled value in
their config and end up with invalid Lua.
2022-08-29 22:48:54 -07:00
16f84ec87a
doc: Improve the "See also" section.
...
Now display:
* The description summary.
* The item kind.
* The module name (if non-local).
2022-08-29 22:48:54 -07:00
Aire-One
e15205a548
add(css) .image-object max-size ( #17 )
...
Co-authored-by: Emmanuel Lepage Vallée <elv1313@gmail.com>
2022-08-29 22:48:54 -07:00
Aire-One
e50b41b10d
add(ltp) .function anchor copy link to clipboard
2022-08-29 22:48:54 -07:00
df45322eac
doc: Implement responsive, toggleable sidebar
...
Below a screen width of 768px (Bootstrap's "medium" breakpoint)
the sidebar will collapse to a small strip. Hovering the sidebar will
fully reveal it until the mouse leaves it.
Clicking the sidebar will reveal it until another part of the page is
clicked.
2022-08-29 22:48:54 -07:00
37114f6181
doc: Remove empty containers
2022-08-29 22:48:54 -07:00
345de1e9d9
bug: Add workaround for new image paths
2022-08-29 22:48:54 -07:00
b8cd009b37
doc: Fix a rendering issue in @tfield and @field.
...
It would render `tag.awful.tag.layouts` instead of `awful.tag.layouts.
2022-08-29 22:48:54 -07:00
86b6f1cb34
doc: Fix another CMake related encoding problem.
2022-08-29 22:48:54 -07:00
87a69c4d4d
doc: Fix a problem which causes the SVG to be blurry.
2022-08-29 22:48:54 -07:00
e4b9728260
doc: Add a mild hover color change to the summary.
...
It is hard know to which row a "chip" like inherited belongs to. This
fixes it for mouse users.
I also tried using alternate row colors, but our colors are so "light"
that there wasn't any good candidate between "white" and the <body>
background color.
2022-08-29 22:48:54 -07:00
2c1c37fb12
doc: Merge the Inherited/Deprecated/Readonly tag style.
...
They are on the right like Inherited, but use the "chip" style of
ReadOnly.
2022-08-29 22:48:54 -07:00
b3cf35d988
doc: Replace hardcoded colors with CSS in the static images.
...
find ../docs/images -iname '*.svg' | xargs -i ../tests/examples/_postprocess.lua {} {}
2022-08-29 22:48:54 -07:00
b6214af364
doc: Add a `deprecatedmethod` tag.
...
Like all the others, but for a method.
2022-08-29 22:48:36 -07:00
2f3bce00e6
tasklist: Refactor to base a normal widget.
...
It was previously monkey-patching the input layout object into
the final tasklist.
This is a breaking change, but affects undocumented behaviors. By
doing this, it becomes possible to expose the properties in the
public API. This, in turn, allows to document them. Right now,
the documentation is very vague on some behaviors.
2022-08-29 22:47:55 -07:00
d8c0ed8066
rectified the installation steps for .deb package
...
the deb package is generated inside a build directory , we have to cd to it before apt install
2022-06-09 10:16:12 +01:00
7451c6952e
fix: Docs update to specify rule callback as being run before properties applied
...
fix(rule_callback): Docs update to specify rule callback as being run before
properties applied
2021-12-23 14:02:24 -08:00
632b0c0d7b
docs: Add code styling for first line in item descriptions
...
LDoc doesn't wrap the first line/paragraph of an item's description
in `<p>` tags, so the previous style rules wouldn't apply to them.
2021-12-21 16:34:26 +01:00
1953c97ce3
docs: Add code styling for parameter default values
2021-12-21 16:33:54 +01:00
1dd1e2c994
docs: Remove "last updated" timestamp
...
The setup to have fixed values for the calendar widget examples
broke the timestamp, and it would always show the same date.
Additionally, even the v4.3 doc was last updated this year (2021),
while there was no change to that version's code in three years.
2021-12-21 15:03:30 +01:00
e4afd437e4
docs(mousegrabber): Prevent Markdown parsing in identifier names
2021-12-21 10:25:05 +01:00
7b13f80778
docs(ruled): Fix incorrect property documentation
...
Commit history suggests that this was just a mistake when writing
the file. Nothing suggests that the implementation was supposed to
changed instead.
2021-12-21 08:38:19 +01:00
1932bd017f
doc(readme): link to building and testing ( fixes #3514 ) ( #3515 )
2021-11-28 14:59:51 -08:00
0afb719f82
doc: Improve the progressbar doc.
...
Another commit in the "lets finish the widget doc" serie.
2021-11-02 20:36:07 -07:00
d5fae3f3dc
Merge pull request #3478 from Elv13/better_shims
...
Fix a few sequences template bugs
2021-10-28 12:27:11 -07:00
7d6892992c
client: Change the `relative_move` behavior.
...
The old behavior would move the client when `nil` was passed by
an almost arbitrary value. It would most of the time go off screen.
While this is a behavior change, what it replaces was so broken I
doubt anybody actually used `nil` in `relative_move`.
2021-10-27 18:30:30 -07:00
6a92af1662
Adding readonly tag to the summary
2021-10-27 14:52:25 -04:00
486fd3744f
Adding ldoc readonly tag text in the extra_summary list
2021-10-26 18:31:45 -04:00
899f9c8879
Adding readonly ldoc tag
2021-10-26 18:07:20 -04:00
60dfa3f6bd
Fixing a typo
2021-10-26 18:06:38 -04:00
ebc9b99ae2
fixed a typo ( #3481 )
2021-10-23 20:02:34 -07:00
ae71158093
doc: Add documentation for the client "window factor" related functions
...
It might be a good idea to deprecate them and move them to the tag
class. However, these APIs are not exactly well designed, so
moving them wont solve that. Some day the dynamic client layout will
hopefully be merged and send these functions to the heap of smelly
bad ideas trash.
2021-10-18 14:38:37 -07:00
93283a9885
doc: Undocument internal client `urgent` and `shape` methods.
...
There is already some permissions to change the behavior. I don't
think there is valid user-facing use cases for these "methods".
2021-10-18 14:38:37 -07:00
5f321df4cc
doc: Fix the image link on the index page.
2021-10-04 10:38:05 -07:00
7806763667
Update docs/05-awesomerc.md.lua
...
Co-authored-by: Aire-One <aireone@aireone.xyz>
2021-09-24 08:42:42 -07:00
70cd293839
doc: Integrate `awful.wallpaper` into the guides.
2021-09-24 08:42:42 -07:00
883cdb7f41
doc: Fix the rendering of double quotes and semicolons
...
CMake uses quotes and semicolon in its internal list datatype.
Previously, all double quotes were converted to single quotes to
avoid this problem. Semicolors were interpreted as newlines in
ldoc.
With this commit, both of them render fine. This was required
because a new example uses CSS and XML where those symbols have
a specific meanning.
2021-09-24 08:42:42 -07:00
be45b40cdb
Remove Vicious as async counterexample
...
Vicious has stopped using io.popen since October 2019.
2021-08-12 21:12:33 +07:00
8a81745d4d
doc(index.html): fixed broken links ( #3402 )
...
Fixes #3393 , where links to guides were hard-coded, and pointed to wrong
places in the git version.
2021-08-04 11:07:57 -07:00
4b494952da
Merge pull request #3400 from aflorea-2k/06-appearance.md_duplicates-fix
...
06 appearance.md duplicates fix (fixes #3328 )
2021-08-02 18:13:35 -07:00
ddb88ed945
List of values in table renders as HTML list
...
Co-authored-by: Aire-One <Aire-One@users.noreply.github.com>
2021-08-02 14:48:50 +02:00
5f5b1dcb2b
Removed dupicate computation of values
2021-08-02 14:46:20 +02:00
b73b885c1e
06-appearance.md no longer mentions duplicates. ( fixes #3328 )
...
The table entries that were duplicated are now side by side.
There are no longer duplicates in the sample file.
2021-07-31 17:29:56 +02:00
05ca439ed5
doc(mousegrabber): Improve cursor list
...
Utilize screen space better with a flex list, compared to a
single-column table.
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-07-31 15:04:54 +02:00
66bb09718b
docs/_parser.lua: parse_files() doesn't produce duplicate entries
...
anymore.
TODO: Handle duplicate's links.
2021-07-31 11:42:38 +02:00
f214ef16a7
doc(w.l.fixed): Improve docs for common layout methods
...
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-07-14 23:00:30 +02:00
Aire-One
6b97ec3307
doc(ltp) Change author mention
2021-06-14 17:03:26 +02:00
8c422d4f68
docs(faq): Add tip for missing .desktop file
...
Re-implements #3282 .
Co-authored-by: HolySuicidalTurkey <63883308+HolySuicidalTurkey@users.noreply.github.com>
2021-05-22 15:55:58 +02:00
9a3ff8eb95
docs(w.l.fixed): Fix incorrect wording
...
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-05-21 19:54:49 +02:00
e0244e60da
docs(tutorial): Add missing theme
...
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-05-21 19:54:48 +02:00
Emmanuel Lepage Vallee
Aire-One
Lucas Schwiderski
Mehdi YC
HumblePresent
Actionless Loveless
Sergey
paulhersch
Nguyễn Gia Phong
aflorea-2k
Andrei Florea