doc: Remove the old module alias hack.

The module names for also have their alias. The commit also remove 2
deprecated module that were forgotton in the previous "get rid of the
deprecated modules in the doc" PR.
This commit is contained in:
Emmanuel Lepage Vallee 2019-06-06 04:21:08 -04:00
parent cdeafeff94
commit 6ce4fa6802
8 changed files with 23 additions and 30 deletions

View File

@ -286,9 +286,6 @@ if(GENERATE_DOC)
# Copy the images to the build directory # Copy the images to the build directory
file(COPY ${SOURCE_DIR}/docs/images DESTINATION ${BUILD_DIR}/doc) file(COPY ${SOURCE_DIR}/docs/images DESTINATION ${BUILD_DIR}/doc)
# Copy the aliases to the build directory
file(COPY ${SOURCE_DIR}/docs/aliases DESTINATION ${BUILD_DIR}/docs)
# Copy ldoc files. # Copy ldoc files.
configure_file(${SOURCE_DIR}/docs/ldoc.css ${BUILD_DIR}/docs COPYONLY) configure_file(${SOURCE_DIR}/docs/ldoc.css ${BUILD_DIR}/docs COPYONLY)
configure_file(${SOURCE_DIR}/docs/ldoc.ltp ${BUILD_DIR}/docs COPYONLY) configure_file(${SOURCE_DIR}/docs/ldoc.ltp ${BUILD_DIR}/docs COPYONLY)

View File

@ -1,5 +0,0 @@
---------------------------------------------------------------------------
--- This module documentation has been merged with the `client` class.
--
-- @module awful.client
---------------------------------------------------------------------------

View File

@ -1,5 +0,0 @@
---------------------------------------------------------------------------
--- This module documentation has been merged with the `mouse` class.
--
-- @module awful.mouse
---------------------------------------------------------------------------

View File

@ -1,5 +0,0 @@
---------------------------------------------------------------------------
--- This module documentation has been merged with the `screen` class.
--
-- @module awful.screen
---------------------------------------------------------------------------

View File

@ -1,5 +0,0 @@
---------------------------------------------------------------------------
--- This module documentation has been merged with the `tag` class.
--
-- @module awful.tag
---------------------------------------------------------------------------

View File

@ -15,8 +15,8 @@
-- <tr><td><a href='../classes/client.html#client.callback'>callback</a></td><td>A function to call when this client is ready</td></tr> -- <tr><td><a href='../classes/client.html#client.callback'>callback</a></td><td>A function to call when this client is ready</td></tr>
-- <tr><td><a href='../classes/client.html#client.marked'>marked</a></td><td>If a client is marked or not</td></tr> -- <tr><td><a href='../classes/client.html#client.marked'>marked</a></td><td>If a client is marked or not</td></tr>
-- <tr><td><a href='../classes/client.html#client.is_fixed'>is\_fixed</a></td><td>Return if a client has a fixed size or not</td></tr> -- <tr><td><a href='../classes/client.html#client.is_fixed'>is\_fixed</a></td><td>Return if a client has a fixed size or not</td></tr>
-- <tr><td><a href='../classes/client.html#client.immobilized'>immobilized</a></td><td>Is the client immobilized horizontally?</td></tr> -- <tr><td><a href='../classes/client.html#client.immobilized_horizontal'>immobilized\_horizontal</a></td><td>Is the client immobilized horizontally?</td></tr>
-- <tr><td><a href='../classes/client.html#client.immobilized'>immobilized</a></td><td>Is the client immobilized vertically?</td></tr> -- <tr><td><a href='../classes/client.html#client.immobilized_vertical'>immobilized\_vertical</a></td><td>Is the client immobilized vertically?</td></tr>
-- <tr><td><a href='../classes/client.html#client.floating'>floating</a></td><td>The client floating state</td></tr> -- <tr><td><a href='../classes/client.html#client.floating'>floating</a></td><td>The client floating state</td></tr>
-- <tr><td><a href='../classes/client.html#client.x'>x</a></td><td>The x coordinates</td></tr> -- <tr><td><a href='../classes/client.html#client.x'>x</a></td><td>The x coordinates</td></tr>
-- <tr><td><a href='../classes/client.html#client.y'>y</a></td><td>The y coordinates</td></tr> -- <tr><td><a href='../classes/client.html#client.y'>y</a></td><td>The y coordinates</td></tr>

View File

@ -121,11 +121,6 @@ file = {
'../lib/', '../lib/',
-- Auto generated scripts -- Auto generated scripts
'../script_files/', '../script_files/',
-- Old APIs the user should not longer use directly
'../docs/aliases/awful_client.lua',
'../docs/aliases/awful_screen.lua',
'../docs/aliases/awful_tag.lua',
'../docs/aliases/awful_mouse.lua',
exclude = { exclude = {
-- exclude these modules, as they do not contain any written -- exclude these modules, as they do not contain any written
-- documentation -- documentation
@ -149,6 +144,8 @@ file = {
-- in the index -- in the index
'../lib/awful/widget/graph.lua', '../lib/awful/widget/graph.lua',
'../lib/awful/widget/progressbar.lua', '../lib/awful/widget/progressbar.lua',
'../lib/awful/widget/textclock.lua',
'../lib/awful/wibox.lua',
'../lib/wibox/layout/constraint.lua', '../lib/wibox/layout/constraint.lua',
'../lib/wibox/layout/margin.lua', '../lib/wibox/layout/margin.lua',
'../lib/wibox/layout/mirror.lua', '../lib/wibox/layout/mirror.lua',
@ -163,6 +160,14 @@ local no_prefix = {
deprecatedproperty = true, deprecatedproperty = true,
} }
-- These modules merge the doc of their `awful` siblings.
local coreclassmap = {
tag = "tag<span class='listplusign'> and awful.tag</span>",
screen = "screen<span class='listplusign'> and awful.screen</span>",
client = "client<span class='listplusign'> and awful.client</span>",
mouse = "mouse<span class='listplusign'> and awful.mouse</span>",
}
custom_display_name_handler = function(item, default_handler) custom_display_name_handler = function(item, default_handler)
-- Remove the "namespace" from the signals and properties -- Remove the "namespace" from the signals and properties
if no_prefix[item.type] then if no_prefix[item.type] then
@ -170,6 +175,11 @@ custom_display_name_handler = function(item, default_handler)
return name ~= "" and name or item.name return name ~= "" and name or item.name
end end
-- Handle the left sidebar modules.
if item.type == "coreclassmod" and coreclassmap[item.name] then
return coreclassmap[item.name]
end
if item.type == "deprecated" or item.type == "deprecatedproperty" then if item.type == "deprecated" or item.type == "deprecatedproperty" then
return default_handler(item) .. "<i class=\"deprecated_label\"> [deprecated]</i>" return default_handler(item) .. "<i class=\"deprecated_label\"> [deprecated]</i>"
end end

View File

@ -355,6 +355,12 @@ a:target + * {
background-color: #FF9; background-color: #FF9;
} }
/* tag + awful.tag */
.listplusign {
color: #b7c1ff;
text-decoration: underline;
text-decoration-color: white;
}
/* styles for prettification of source */ /* styles for prettification of source */
pre .comment { color: #bbccaa; } pre .comment { color: #bbccaa; }