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
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
9807ccd5e0
fix(ldoc.ltp): extra-header tag arrangement ( #3318 )
2021-04-05 09:42:15 -07:00
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
112dc8054e
docs(tutorial): Fix line wrap
...
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-31 08:29:40 +02:00
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
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
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
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
ce5196424e
Docs: Fix code example for cairo usage. ( #3295 )
2021-03-22 15:05:46 -07:00
d583129eb6
Merge pull request #3143 from Elv13/doc_client_layout
...
Document the client layout properties
2021-03-22 12:10:36 -07:00
b4cf88f4c0
doc: Fix the titlebars widget constructor doc
2021-03-22 00:56:02 -07:00
522d628c2c
doc: Complete the widget documentation page.
...
This adds the `awful.widget` content along with some images.
2021-03-22 00:54:00 -07:00
ac0aeb65c0
doc: Modernize the landing page.
...
The previous index.html was scary and the most useful links were
at the bottom. This commit fixes that.
It also adds an image of the default config with some labels to name
all visible components.
2021-03-22 00:54:00 -07:00
Aire-One
8bdabb234b
draft
2021-03-21 23:58:05 -07:00
08a1018775
Add changelog for breaking change
...
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-08 20:09:57 +01:00
1518b0f4c0
Border_marked naming consistency ( #3084 )
...
* finish renaming border_marked to border_color_marked
* doc: document border_color_fullscreen, update border_color_marked and fix typo
* deprecate instead of removing
* doc: fix border_color_marked
2020-05-04 01:42:09 -07:00
b959c9de1a
docs: Fix wrong code example in "03-declarative-layout"
2020-04-16 18:23:50 +00:00
d408ec7846
doc: Use a more compact rendering for method return types.
2020-02-29 21:17:27 -05:00
79dd2d731a
doc: Improve the method and function rendering.
...
It now adds the return type to the signature.
2020-02-29 21:17:27 -05:00
5f9bd77bd9
doc: Do not add parentheses arpund property types.
...
They provide no value.
2020-02-29 21:17:27 -05:00
c4bc882825
doc: Update wallaper example in tutorial
...
Reported by elbuggito in IRC that this the example line is no longer present in the default theme.lua.
2020-02-28 08:53:02 +00:00
9f5a17ed98
doc: Add the notification property table.
...
This is autogenerated using the `build_rules_index.lua` script.
2020-02-15 20:33:21 -05:00
c1d59fef24
doc: Build property indexes for more classes instead of only client.
...
These index will be used for the rules documentation.
2020-02-15 20:33:21 -05:00
3da2264df2
doc: Add a shared section for the signal documentation.
2020-02-15 20:33:21 -05:00
d755a877ff
doc: Add a new manual page describing the command line options.
2020-02-08 17:59:16 -05:00
8df463f971
doc: Improve the client documentation.
2020-01-19 20:30:06 -05:00
46026ccc2e
doc: Fix a regression that added another space in the URL.
...
This will break some existing links, but oh well, it isn't the first
time and some websites cannot render URLs with spaces in them. This
means external references to some of the input doc are currently
impossible.
2020-01-19 20:30:06 -05:00
31e0a3e67b
doc: Fix the item summary rendering.
...
* Correctly count the elements
* Use singular and plural tense properly
2020-01-19 20:30:06 -05:00
74ba84b299
doc: Make use of the @classsignal tag.
...
It wasn't doing anything until now.
2020-01-19 20:30:06 -05:00
575b0f12dc
doc: Remove all type aliases.
...
They render poorly and serve no purpose.
#!/bin/bash
for FILE in $(git ls-files | grep -E "\.(h|c|lua)" | grep -v tests | grep -v spec); do
sed -i 's/^[ ]*--*[ ]*@client /-- @tparam client /g' $FILE
done
2020-01-19 20:30:06 -05:00
Nguyễn Gia Phong
aflorea-2k
Emmanuel Lepage Vallée
Andrei Florea
Lucas Schwiderski
Aire-One
mergify[bot]
Aire-One
Jonas Belouadi
Unai
Michael
Matthew Wild
Uli Schlachter