Commit Graph

415 Commits

Author SHA1 Message Date
Emmanuel Lepage Vallee f6370c45c3 docs.common.widget.ldoc: Update the property documentation. 2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee 0cf97e007d docs.common.wibox.ldoc: Update the property documentation. 2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee 50c98059b8 doc: Fix a rendering problem.
Beause the HTML was indented with more than 3 spaces, it was converted
to mardown when using the fallback (not discount) markdown rendered.
2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee a722a67679 doc: Fix a CSS regression from a recent commit. 2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee 9c6ac7ec35 doc: Enforce a strict schema for all @property entries.
It now requires some extra tags to be added. With the new constraints,
the rendering is much more detailed.
2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee 27f329a229 doc: Add a standard way to add metadata to the property documentation. 2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee a698d20e81 doc: Add more property warnings.
The goal is to fix these issues so the new rendering can become
stable.
2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee 19e586f969 doc: Replace the rendering for the @property default values. 2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee 31061cb2e6 doc: Add @range_stop, @range_start, @property_value and @property_unit.
This will be used in the next commit to describe properties in a more
consistent way.
2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee 4fa957b75d doc: Force all properties to document their default value. 2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee 86d1b1c22c doc: Add a mandatory `@noreturn` for functions and methods.
The goal is to catch cases where the return value exists, but is
forgotten. There was a large enough number of them to turn this
into a real check. Initially, I just wanted to implement it to fix
the problems, then delete the code. But since this is so common, I
think it is worth the annoyance.
2022-08-29 22:49:45 -07:00
Emmanuel Lepage Vallee 4bd90f0f35 doc: Add documentation linting and fix all issues it found. 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee f3987f43b6 doc: More proof reading fixes. 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 4a6385cf40 doc: Replace the function argument rendering.
This is an attempt at solving several problems reported by novice
users. The old rendering was very compact and quite fine once you
got used to its, ..., "conventions". But it was also sometime rather
hard to read.

First of all, it abused bold and italic. It also "merged" optional
parameters and parameters with default content. It got worst when
the documentation was spread over mutiple lines.

For property types and constructors with large number of parameters,
it was also quite unreadable.

The new representation, while far from perfect, is less dense and
more explicit. It has a separate column for "optional" using the
new "metadata chip" documentation concept. It is also an aligned
table and correctly renders multi-line documentation.

Finally, it adds a "note" message when the named parameter convention
is used. This way the users looking at the examples will be less
confused.
2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee f26642f037 doc: Fix mnor rendering issues.
The module name wasn't present when it should have been. Same for
the function params.
2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 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
Emmanuel Lepage Vallee 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
Lucas Schwiderski 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
Lucas Schwiderski 37114f6181 doc: Remove empty containers 2022-08-29 22:48:54 -07:00
Lucas Schwiderski 345de1e9d9 bug: Add workaround for new image paths 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 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
Emmanuel Lepage Vallee 86b6f1cb34 doc: Fix another CMake related encoding problem. 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 87a69c4d4d doc: Fix a problem which causes the SVG to be blurry. 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 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
Emmanuel Lepage Vallee 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
Emmanuel Lepage Vallee 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
Emmanuel Lepage Vallee b6214af364 doc: Add a `deprecatedmethod` tag.
Like all the others, but for a method.
2022-08-29 22:48:36 -07:00
Emmanuel Lepage Vallee 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
Mehdi YC 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
HumblePresent 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
Lucas Schwiderski 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
Lucas Schwiderski 1953c97ce3
docs: Add code styling for parameter default values 2021-12-21 16:33:54 +01:00
Lucas Schwiderski 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
Lucas Schwiderski e4afd437e4
docs(mousegrabber): Prevent Markdown parsing in identifier names 2021-12-21 10:25:05 +01:00
Lucas Schwiderski 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
Actionless Loveless 1932bd017f
doc(readme): link to building and testing (fixes #3514) (#3515) 2021-11-28 14:59:51 -08:00
Emmanuel Lepage Vallee 0afb719f82 doc: Improve the progressbar doc.
Another commit in the "lets finish the widget doc" serie.
2021-11-02 20:36:07 -07:00
Emmanuel Lepage Vallée d5fae3f3dc
Merge pull request #3478 from Elv13/better_shims
Fix a few sequences template bugs
2021-10-28 12:27:11 -07:00
Emmanuel Lepage Vallee 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
Sergey 6a92af1662 Adding readonly tag to the summary 2021-10-27 14:52:25 -04:00
Sergey 486fd3744f Adding ldoc readonly tag text in the extra_summary list 2021-10-26 18:31:45 -04:00
Sergey 899f9c8879 Adding readonly ldoc tag 2021-10-26 18:07:20 -04:00
Sergey 60dfa3f6bd Fixing a typo 2021-10-26 18:06:38 -04:00
paulhersch ebc9b99ae2
fixed a typo (#3481) 2021-10-23 20:02:34 -07:00
Emmanuel Lepage Vallee 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
Emmanuel Lepage Vallee 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
Emmanuel Lepage Vallee 5f321df4cc doc: Fix the image link on the index page. 2021-10-04 10:38:05 -07:00
Emmanuel Lepage Vallée 7806763667 Update docs/05-awesomerc.md.lua
Co-authored-by: Aire-One <aireone@aireone.xyz>
2021-09-24 08:42:42 -07:00