Miroirs/awesome
1
0
Fork 0
mirror of https://github.com/awesomeWM/awesome synced 2024-11-17 07:47:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix images in the documentation

Browse source 
Instead of copying images to ${BUILD_DIR}/docs/images, which is the directory
with the input to ldoc, this now copies the images to ${BUILD_DIR}/doc/images,
which is where ldoc generates its output. That way, the images are together with
the html files and are automatically picked up by a lot of stuff.

Fixes: https://github.com/awesomeWM/awesome/issues/681
Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2016-02-13 08:04:14 +01:00
parent 0a15ea9131
commit 3bc8aa2d40
2 changed files with 3 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CMakeLists.txt
View file

@ -34,13 +34,6 @@ set(AWE_DOC_FILES
${AWE_DOC_DIR}/02-contributing.md ${AWE_DOC_DIR}/02-contributing.md
${SOURCE_DIR}/LICENSE) ${SOURCE_DIR}/LICENSE)
if (GENERATE_DOC)
set(AWE_DOC_IMAGES
${AWE_DOC_DIR}/images/widgetlayout1.png
${AWE_DOC_DIR}/images/widgetlayout2.png
)
endif()
set(AWE_SRCS set(AWE_SRCS
${BUILD_DIR}/awesome.c ${BUILD_DIR}/awesome.c
${BUILD_DIR}/banning.c ${BUILD_DIR}/banning.c
@ -267,7 +260,7 @@ if(GENERATE_DOC)
file(GLOB_RECURSE AWE_MD_FILES ${AWE_DOC_DIR}/*.md) file(GLOB_RECURSE AWE_MD_FILES ${AWE_DOC_DIR}/*.md)
# Copy the images to the build directory # Copy the images to the build directory
file(COPY ${SOURCE_DIR}/docs/images DESTINATION ${AWE_DOC_DIR}) file(COPY ${SOURCE_DIR}/docs/images DESTINATION ${BUILD_DIR}/doc)
# Run ldoc and make it fail if any warnings are generated. The # Run ldoc and make it fail if any warnings are generated. The
# redirection-magic swaps stdout and stderr and awk exits with a non-zero # redirection-magic swaps stdout and stderr and awk exits with a non-zero
@ -352,7 +345,6 @@ install(DIRECTORY ${SOURCE_DIR}/themes DESTINATION ${AWESOME_DATA_PATH}
install(DIRECTORY ${BUILD_DIR}/themes DESTINATION ${AWESOME_DATA_PATH} install(DIRECTORY ${BUILD_DIR}/themes DESTINATION ${AWESOME_DATA_PATH}
PATTERN "*.lua") PATTERN "*.lua")
install(FILES ${AWE_DOC_FILES} DESTINATION ${AWESOME_DOC_PATH}) install(FILES ${AWE_DOC_FILES} DESTINATION ${AWESOME_DOC_PATH})
install(FILES ${AWE_DOC_IMAGES} DESTINATION ${AWESOME_DOC_PATH}/images)
install(FILES "awesome.desktop" DESTINATION ${AWESOME_XSESSION_PATH}) install(FILES "awesome.desktop" DESTINATION ${AWESOME_XSESSION_PATH})
if(GENERATE_DOC) if(GENERATE_DOC)
install(DIRECTORY ${BUILD_DIR}/doc DESTINATION ${AWESOME_DOC_PATH}) install(DIRECTORY ${BUILD_DIR}/doc DESTINATION ${AWESOME_DOC_PATH})

4
docs/03-declarative-layout.md
View file

@ -75,7 +75,7 @@ Code:
Result: Result:
![Example2 screenshot](../../docs/images/widgetlayout1.png) ![Example2 screenshot](../images/widgetlayout1.png)
## Use an `wibox.layout.align` layout ## Use an `wibox.layout.align` layout
@ -114,7 +114,7 @@ Code:
} }
Result: Result:
![Example4 screenshot](../../docs/images/widgetlayout2.png) ![Example4 screenshot](../images/widgetlayout2.png)
For more information about how to draw widgets, refer to the `Cairo` api: For more information about how to draw widgets, refer to the `Cairo` api: