pgrondek/polybar-dwm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
16b2970bd7
polybar-dwm/doc/CMakeLists.txt

70 lines
2.2 KiB
CMake
Raw Normal View History

build: Bump cmake version to 3.5.0 This includes the changes from polybar/xpp#30 which also updates the minimum cmake version in the xpp submodule
2020-12-22 00:58:21 +00:00
cmake_minimum_required(VERSION 3.5.0 FATAL_ERROR)
build: Allow doc to build as its own project We can now build the docs without having to have installed all dependencies for polybar.
2019-04-30 19:52:17 +00:00
# Only used if documentation is built on its own
project(polybar-doc NONE)
doc: Set SPHINX_BUILD in standalone doc builds If we build only the documentation by invoking `cmake` on the `doc` folder, the `SPHINX_BUILD` variable is not set and instead of ``` sphinx-build -b html ... ``` it will just execute ``` -b html ... ``` This produces an error but doesn't fail the build because apparently if the command starts with a dash an error is non-fatal. Fixes #2191
2020-10-03 12:54:20 +00:00
if(NOT SPHINX_BUILD)
set(SPHINX_BUILD "sphinx-build")
endif()
refactor(doc): Use cmake APP_VERSION in conf.py This also moves the doc generation completely into cmake (no more Makefile). To generate the docs the project needs to first be configured and then `make doc` can be run. The approach used is leaned on the cmake's project own use of Sphinx: Utilities/Sphinx/CMakeLists.txt
2018-12-14 08:34:31 +00:00
set(SPHINX_FLAGS "" CACHE STRING "Flags to pass to sphinx-build")
separate_arguments(sphinx_flags UNIX_COMMAND "${SPHINX_FLAGS}")
doc: Build doc with cmake Run `make doc` inside the cmake build folder. The html output is installed to ${CMAKE_INSTALL_PREFIX}/share/doc/polybar
2018-12-01 13:10:03 +00:00
refactor(doc): Use cmake APP_VERSION in conf.py This also moves the doc generation completely into cmake (no more Makefile). To generate the docs the project needs to first be configured and then `make doc` can be run. The approach used is leaned on the cmake's project own use of Sphinx: Utilities/Sphinx/CMakeLists.txt
2018-12-14 08:34:31 +00:00
set(doc_path "${CMAKE_CURRENT_SOURCE_DIR}")
build: Allow doc to build as its own project We can now build the docs without having to have installed all dependencies for polybar.
2019-04-30 19:52:17 +00:00
# Configures conf.py in the current folder and puts it in the build folder
configure_file(conf.py conf.py @ONLY)
refactor(doc): Use cmake APP_VERSION in conf.py This also moves the doc generation completely into cmake (no more Makefile). To generate the docs the project needs to first be configured and then `make doc` can be run. The approach used is leaned on the cmake's project own use of Sphinx: Utilities/Sphinx/CMakeLists.txt
2018-12-14 08:34:31 +00:00
# We want to run `sphinx-build` with the following builders
set(doc_builders "html" "man")
# Name of all documentation targets
set(doc_targets "")
foreach(builder ${doc_builders})
set(doc_target "doc_${builder}")
set(builder_log "builder-${builder}.log")
add_custom_target(${doc_target}
doc: Allow custom SPHINX_BUILD
2019-10-03 20:42:31 +00:00
COMMAND ${SPHINX_BUILD}
refactor(doc): Use cmake APP_VERSION in conf.py This also moves the doc generation completely into cmake (no more Makefile). To generate the docs the project needs to first be configured and then `make doc` can be run. The approach used is leaned on the cmake's project own use of Sphinx: Utilities/Sphinx/CMakeLists.txt
2018-12-14 08:34:31 +00:00
-b ${builder}
build: Allow doc to build as its own project We can now build the docs without having to have installed all dependencies for polybar.
2019-04-30 19:52:17 +00:00
# conf.py dir
refactor(doc): Use cmake APP_VERSION in conf.py This also moves the doc generation completely into cmake (no more Makefile). To generate the docs the project needs to first be configured and then `make doc` can be run. The approach used is leaned on the cmake's project own use of Sphinx: Utilities/Sphinx/CMakeLists.txt
2018-12-14 08:34:31 +00:00
-c "${CMAKE_CURRENT_BINARY_DIR}"
-d "${CMAKE_CURRENT_BINARY_DIR}/doctrees"
${sphinx_flags}
build: Allow doc to build as its own project We can now build the docs without having to have installed all dependencies for polybar.
2019-04-30 19:52:17 +00:00
# Documentation source file dir
"${CMAKE_CURRENT_SOURCE_DIR}"
# Output dir
refactor(doc): Use cmake APP_VERSION in conf.py This also moves the doc generation completely into cmake (no more Makefile). To generate the docs the project needs to first be configured and then `make doc` can be run. The approach used is leaned on the cmake's project own use of Sphinx: Utilities/Sphinx/CMakeLists.txt
2018-12-14 08:34:31 +00:00
"${CMAKE_CURRENT_BINARY_DIR}/${builder}" > ${builder_log}
COMMENT "sphinx-build ${builder}: see doc/${builder_log}")
list(APPEND doc_targets ${doc_target})
endforeach()
# Dummy target that depends on all documentation targets
add_custom_target(doc ALL DEPENDS ${doc_targets})
cmake: Use GNUInstallDirs (#1818) * Use GNUInstallDirs instead of hardcoded paths This change should be a no-op in the normal case and at the same time make it easier to customise polybar builds on systems with special needs. * Avoid creating /usr/share/doc/polybar/polybar/* * Include GNUInstallDirs for the doc target itself * cmake: Don't try to set CMAKE_INSTALL_* variables Since we include GNUInstallDirs all these variables are already set * cmake: Print install directories in summary * fix(cmake): Make doc-only work like normal build This is kind of a dirty hack to force CMAKE_INSTALL_DOCDIR to use `polybar` as the project name when only polybar-doc is built. Maybe it is wiser at some point to be able to do a doc only build (and install) that can be done from the top level project. Then we would also not need to include GNUInstallDirs here
2019-06-24 16:08:59 +00:00
# This is needed for the case where only the doc target is built
# CMAKE_INSTALL_DOCDIR uses PROJECT_NAME which is now polybar-doc, to be
# consistent with a regular install we temporarily override it with "polybar"
# before including GNUInstallDirs
# Also since no language is set and GNUInstallDirs cannot set
# CMAKE_INSTALL_LIBDIR, so we set it to a dummy value to suppress a warning
if(${CMAKE_PROJECT_NAME} STREQUAL "polybar-doc")
set(PROJECT_NAME "polybar")
set(CMAKE_INSTALL_LIBDIR "")
include(GNUInstallDirs)
set(PROJECT_NAME "polybar-doc")
endif()
refactor(doc): Use cmake APP_VERSION in conf.py This also moves the doc generation completely into cmake (no more Makefile). To generate the docs the project needs to first be configured and then `make doc` can be run. The approach used is leaned on the cmake's project own use of Sphinx: Utilities/Sphinx/CMakeLists.txt
2018-12-14 08:34:31 +00:00
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/
cmake: Use GNUInstallDirs (#1818) * Use GNUInstallDirs instead of hardcoded paths This change should be a no-op in the normal case and at the same time make it easier to customise polybar builds on systems with special needs. * Avoid creating /usr/share/doc/polybar/polybar/* * Include GNUInstallDirs for the doc target itself * cmake: Don't try to set CMAKE_INSTALL_* variables Since we include GNUInstallDirs all these variables are already set * cmake: Print install directories in summary * fix(cmake): Make doc-only work like normal build This is kind of a dirty hack to force CMAKE_INSTALL_DOCDIR to use `polybar` as the project name when only polybar-doc is built. Maybe it is wiser at some point to be able to do a doc only build (and install) that can be done from the top level project. Then we would also not need to include GNUInstallDirs here
2019-06-24 16:08:59 +00:00
DESTINATION ${CMAKE_INSTALL_DOCDIR}
doc: Build doc with cmake Run `make doc` inside the cmake build folder. The html output is installed to ${CMAKE_INSTALL_PREFIX}/share/doc/polybar
2018-12-01 13:10:03 +00:00
COMPONENT doc)
refactor(doc): Use cmake APP_VERSION in conf.py This also moves the doc generation completely into cmake (no more Makefile). To generate the docs the project needs to first be configured and then `make doc` can be run. The approach used is leaned on the cmake's project own use of Sphinx: Utilities/Sphinx/CMakeLists.txt
2018-12-14 08:34:31 +00:00
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/polybar.1
cmake: Use GNUInstallDirs (#1818) * Use GNUInstallDirs instead of hardcoded paths This change should be a no-op in the normal case and at the same time make it easier to customise polybar builds on systems with special needs. * Avoid creating /usr/share/doc/polybar/polybar/* * Include GNUInstallDirs for the doc target itself * cmake: Don't try to set CMAKE_INSTALL_* variables Since we include GNUInstallDirs all these variables are already set * cmake: Print install directories in summary * fix(cmake): Make doc-only work like normal build This is kind of a dirty hack to force CMAKE_INSTALL_DOCDIR to use `polybar` as the project name when only polybar-doc is built. Maybe it is wiser at some point to be able to do a doc only build (and install) that can be done from the top level project. Then we would also not need to include GNUInstallDirs here
2019-06-24 16:08:59 +00:00
DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
doc: Install rst based man pages
2018-12-02 18:17:26 +00:00
COMPONENT doc)
doc: Write syntax definition in polybar.5
2019-10-03 20:42:47 +00:00
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/polybar.5
DESTINATION ${CMAKE_INSTALL_MANDIR}/man5
COMPONENT doc)
Reference in New Issue Copy Permalink