Commit Graph

383 Commits

Author SHA1 Message Date
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
Emmanuel Lepage Vallee 70cd293839 doc: Integrate `awful.wallpaper` into the guides. 2021-09-24 08:42:42 -07:00
Emmanuel Lepage Vallee 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
Nguyễn Gia Phong be45b40cdb
Remove Vicious as async counterexample
Vicious has stopped using io.popen since October 2019.
2021-08-12 21:12:33 +07:00
aflorea-2k 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
Emmanuel Lepage Vallée 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
aflorea-2k 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
Andrei Florea 5f5b1dcb2b
Removed dupicate computation of values 2021-08-02 14:46:20 +02:00
Andrei Florea 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
Lucas Schwiderski 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
Andrei Florea 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
Lucas Schwiderski 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
Lucas Schwiderski 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
Lucas Schwiderski 9a3ff8eb95
docs(w.l.fixed): Fix incorrect wording
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-05-21 19:54:49 +02:00
Lucas Schwiderski e0244e60da
docs(tutorial): Add missing theme
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-05-21 19:54:48 +02:00
mergify[bot] fda950d186
Merge pull request #3263 from Aire-One/doc_textclock
[doc] Improve wibox.widget.textclock format documentation
2021-04-07 09:59:08 +00:00
Aire-One 6226742f72 doc(wibox.widget.textclock): Widget definition. 2021-04-07 01:38:53 -07:00
Aire-One 9807ccd5e0
fix(ldoc.ltp): extra-header tag arrangement (#3318) 2021-04-05 09:42:15 -07:00
Emmanuel Lepage Vallee 25f4cfcb05 doc(ltp): Implement module `extra-header` section
Co-authored-by: Lucas Schwiderski <lucas@lschwiderski.de>
Co-authored-by: Aire-One <Aire-One@users.noreply.github.com>
2021-04-02 20:00:46 +02:00
Aire-One bc8a5b0230 fix(ldoc.ltp): item.inherited can be wrongly true
For some even more strange reasons than commit 047729ae1, it seems
we can also have the error that `item.inherited` can be sets to `true`
on items that are not inherited...

I just had this issue with `wibox.widget.imagebox` where properties
were marked as inherited from `wibox.widget.imagebox`. Best way to fix
it is to only trust the check on `item.baseclass`, and completly
dismiss its `inherited` property.
2021-04-02 19:24:07 +02:00
Aire-One af3b194a31 doc(@hidden;ldoc.ltp): Add ldoc tag to hide item
Add a new ldoc tag `@hidden`. This tag allows us to keep documentation
for magic methods (e.g. `wibox.widget.base:get_visible`) but prevent
it from being part of the documentation used by final users.
2021-04-02 19:24:07 +02:00
Aire-One 5baa1c97cd fix(ldoc.ltp): Identify inherited items by name 2021-04-02 19:24:07 +02:00
Aire-One 93e9361280 fix(ldoc.ltp): item.inherited can be wrongly false
For some reasons, sometime `item.inherited` is `false` even if the
item was added to the `all_module_kinds` table by the "hierarchy
lookup" for-loop, and we already force the `inherited` property to be
sets to `true` at this moment.

With this commit, we add a second fail-check condition based on the
`item.baseclass` property to determine if the item is inherited or not
when we do the render.
2021-04-02 19:24:07 +02:00
Aire-One b82d2a690f doc(@supermodule;ldoc.ltp): Find inherited members
This commit uses the `@supermodule` tag to recursively find all the
properties from supermodules and add them to the current module
documentation.
2021-04-02 19:24:07 +02:00
Aire-One 4dd689f181 doc(@supermodule;ldoc.ltp): Draw hierarchy tree
This commit adds a new ldoc custom tag `@supermodule`. It has to be
used at the module level. It should refer to the module
supermodules.

This tag can be used multiple time by the same module, but we ignore
other calls (for now?) as (AFAIK) we only use one way inheritance.

This tag is used in the ldoc template to find modules hierarchy and
draw the inheritance tree. It makes it easy to find and navigate to
parents modules.
2021-04-02 19:24:07 +02:00
Lucas Schwiderski 112dc8054e
docs(tutorial): Fix line wrap
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-31 08:29:40 +02:00
Lucas Schwiderski 8907f5bfbb
docs(tutorial): Improve instructions to edit theme
Fixes #3306.

Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-31 08:29:39 +02:00
Lucas Schwiderski f3a0937ea3
Remove advanced building options from README
This removes the section about advanced build options and build
dependencies and points to the docs page instead.

Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-23 10:18:33 +01:00
Lucas Schwiderski cce8e80cbd
Improve code snippet rendering in README
This converts the code snippets to the alternate block definition and
adds language hints to enable syntax highlighting for compatible parsers
(such as on the GitHub page).

Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-23 10:18:32 +01:00
Lucas Schwiderski 849a8b5af4
Add docs section about building and testing
This documents various CMake variables for building and the available
test suites.

Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-23 10:18:29 +01:00
Jonas Belouadi ce5196424e
Docs: Fix code example for cairo usage. (#3295) 2021-03-22 15:05:46 -07:00
Emmanuel Lepage Vallée d583129eb6
Merge pull request #3143 from Elv13/doc_client_layout
Document the client layout properties
2021-03-22 12:10:36 -07:00