Yauhen Kirylau
a35acea61a
Merge branch 'master' into hotkeys-popup-better-split-key-labels
2021-04-23 07:23:26 +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
Emmanuel Lepage Vallee
e3ab76b872
debug: Print *why* the build fails.
2021-04-07 01:38:53 -07: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 Vallée
022be39a3f
doc: Revert the last few commits. ( #3317 )
...
Hopefully, if the boilerplate commit is empty, the script will not
crash.
2021-04-05 01:11:05 -07:00
Emmanuel Lepage Vallée
702db23ee0
Debug doc issue ( #3316 )
...
* doc: More debug messages
The previous commit was inconclusive
REVERT ME
* doc: Another attempt at narrowing the boilerplate commit issue
2021-04-05 00:56:03 -07:00
Emmanuel Lepage Vallée
8e8525dae9
doc: More debug messages ( #3315 )
...
The previous commit was inconclusive
REVERT ME
2021-04-05 00:16:26 -07:00
Emmanuel Lepage Vallée
747b14142f
doc: Debug an issue where the documentation isn't generated properly ( #3314 )
...
This is a test commit, it will be reverted partially or fully.
2021-04-04 23:27:40 -07:00
Emmanuel Lepage Vallée
3dddc2ba78
Merge pull request #3288 from Aire-One/feature/ldoc-inheritance-diagram
...
[doc] Add ldoc @supermodule tag to draw inheritance diagram and manage inherited properties
2021-04-04 22:26:55 -07:00
Aire-One
b184f95195
doc(layout.flex): Hide `fill_space` property doc
...
Add an explicite `@property` tag to the `wibox.layout.flex` doc
comments to override the `fill_space` property from
`wibox.layout.fixed` and mark it as hidden thanks to `@hidden`.
2021-04-02 20:02:39 +02: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
Emmanuel Lepage Vallee
90c4c60d2a
Add more @supermodule and @hidden
2021-04-02 19:24:07 +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
0ae0add45f
doc(imagebox): Fix @method tags
2021-04-02 19:24:07 +02:00
Aire-One
b706aa9bd0
doc(@hidden): Add to wibox.widget.base module
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
20a8d902c5
doc(@supermodule): Add to awful.widget modules
2021-04-02 19:24:07 +02:00
Aire-One
3969ad8819
doc(@supermodule): Add to wibox.layout modules
2021-04-02 19:24:07 +02:00
Aire-One
3b12a8d19a
doc(@supermodule): Add to wibox.container modules
2021-04-02 19:24:07 +02:00
Aire-One
3ed2fc8500
doc(@supermodule): Add to wibox.widget modules
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
12662d4cb1
doc(@supermodule): wibox.widget.base doc
2021-04-02 19:24:07 +02:00
Aire-One
3a6fa10754
doc(@supermodule): gears.object inheritable doc
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
mergify[bot]
7a8fa9d27a
Merge pull request #3294 from sclu1034/feature/count_keys
...
Add utility to count table keys
2021-04-01 07:42:25 +00:00
mergify[bot]
972a194b01
Merge pull request #3307 from sclu1034/feature/docs
...
Various docs improvements
2021-04-01 07:42:11 +00: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
f68939bfc1
chore(g.table): Add missing modeline
2021-03-31 08:29:00 +02:00
Lucas Schwiderski
ec3788bf73
docs(g.table): Improve parameter descriptions
2021-03-31 08:27:08 +02:00
mergify[bot]
95558ac919
Merge pull request #3297 from actionless/dont-crash-when-gtk4-installed
...
fix(beautiful: gtk): don't crash when both gtk3 and gtk4 are installed
2021-03-29 15:49:37 +00:00
Emmanuel Lepage Vallée
13e8408562
Merge pull request #3284 from sclu1034/issue/3213
...
Fix composite widgets with top level container
2021-03-28 16:00:16 -07:00
Lucas Schwiderski
c0380e3080
Remove nonexistent property from example ( #3302 )
...
See
<https://www.reddit.com/r/awesomewm/comments/lzgecn/what_intrusive_true_means_in_the_properties_of/ >.
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-28 15:36:06 -07:00
Emmanuel Lepage Vallée
7050ba083f
Merge pull request #3301 from Elv13/graph_doc
...
Graph doc
2021-03-28 15:34:01 -07:00
Emmanuel Lepage Vallee
743b327348
Revert "Another ugly hack to get Travis to show output"
...
This reverts commit 97a60818c4
.
2021-03-28 02:38:51 -07:00
Emmanuel Lepage Vallee
a5c4377901
Revert "I want to see the error message!!!"
...
This reverts commit 1792780cf3
.
2021-03-28 02:38:43 -07:00
Emmanuel Lepage Vallee
c48e138b01
doc: Add examples for the graph.
2021-03-28 02:37:25 -07:00
Yauhen Kirylau
6ef3a8f059
fix(gears: colors: recolor_image): always duplicate the surface ( #3233 )
2021-03-27 23:48:48 -07:00
Emmanuel Lepage Vallée
54e9cb4e1d
Merge pull request #3279 from sclu1034/feature/custom_build_lua_executable
...
Make CMake Lua executable customizable
2021-03-27 23:42:40 -07:00
Lucas Schwiderski
e7d55567a6
Remove redundant assignment
...
Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-27 14:08:47 +01:00
actionless
e833da0303
fix(beautiful: gtk): don't crash when both gtk3 and gtk4 are installed
2021-03-25 00:21:04 +01: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
Lucas Schwiderski
4d43ccda6d
Rename Lua executable envvar
...
Use `LUA` based on the traditional naming scheme in Makefiles.
2021-03-23 09:10:07 +01:00
Lucas Schwiderski
d9640cf027
Provide default for Lua executable env variable
2021-03-23 09:10:06 +01:00
Lucas Schwiderski
6d0eb8660d
Use Lua executable variable for check-integration
2021-03-23 09:10:05 +01:00