PolytreeDE/polybar
1
0
Fork 0
mirror of https://github.com/polybar/polybar.git synced 2024-11-11 13:50:56 -05:00
Code Releases Activity
polybar/doc/CMakeLists.txt

76 lines
2.2 KiB
Text
Raw Normal View History

Add cmake files for configuring individual targets This makes the code a bit less messy. We barely need if(BUILD_...) guards inside the cmake files, just the root CMakeLists.txt.
2020-12-22 06:19:46 -05:00
set(SPHINX_BUILD "sphinx-build" CACHE STRING "Name/Path of the sphinx-build executable to use.")
set(SPHINX_FLAGS "" CACHE STRING "Flags to pass to sphinx-build")
find_program(BIN_SPHINX "${SPHINX_BUILD}")
if(NOT BIN_SPHINX)
message(FATAL_ERROR "sphinx-build executable '${SPHINX_BUILD}' not found.")
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 03:34:31 -05:00
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 08:10:03 -05: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 03:34:31 -05: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 15:52:17 -04: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 03:34:31 -05:00
# We want to run `sphinx-build` with the following builders
build: Add option to enable/disable html/manpages
2020-12-22 06:29:26 -05:00
if (BUILD_DOC_HTML)
list(APPEND doc_builders "html")
endif()
if (BUILD_DOC_MAN)
list(APPEND doc_builders "man")
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 03:34:31 -05:00
# 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}
refactor(cmake): Allow targets to be enabled individually Each major target of polybar can now be enabled/disabled while configuring (even polybar itself). The cmake code specific to each target will only run if the target is enabled. This allows us to for example just build the documentation without having to run all the cmake code related to compilation or having the polybar dependencies installed (other than sphinx).
2020-12-21 21:43:06 -05:00
COMMAND ${BIN_SPHINX}
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 03:34:31 -05: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 15:52:17 -04: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 03:34:31 -05:00
-c "${CMAKE_CURRENT_BINARY_DIR}"
-d "${CMAKE_CURRENT_BINARY_DIR}/doctrees"
sphinx: Turn on nit-picky mode
2021-01-07 08:19:48 -05:00
-n
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 03:34:31 -05:00
${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 15:52:17 -04: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 03:34:31 -05: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})
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 12:08:59 -04:00
DESTINATION ${CMAKE_INSTALL_DOCDIR}
doc: Exclude .buildinfo file from installation The file contains information about the build itself (hashed) and is not really useful.
2021-01-07 08:15:02 -05:00
COMPONENT doc
PATTERN ".buildinfo" EXCLUDE)
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 08:10:03 -05:00
Install changelog file as part of the documentation
2021-01-07 08:19:59 -05:00
install(FILES ${CMAKE_SOURCE_DIR}/CHANGELOG.md
DESTINATION ${CMAKE_INSTALL_DOCDIR}
COMPONENT doc)
Create default config (#2511) * Create default config and install to /etc/polybar Closes #2405 * Search for config in /etc We search in XDG_CONFIG_DIRS, /etc/xdg, and /etc but only for config.ini Closes #2016 * Remove config installation from build.sh * Remove userconfig cmake file * Cleanup * Cleanup default config * Update CHANGELOG.md Co-authored-by: dvermd <315743+dvermd@users.noreply.github.com> * Update src/main.cpp Co-authored-by: dvermd <315743+dvermd@users.noreply.github.com> * Add tests for string functions * Support loading bars from fallbacks in /etc * Combine duplicate string_util::contains test Co-authored-by: dvermd <315743+dvermd@users.noreply.github.com>
2021-10-05 07:07:19 -04:00
install(FILES ${CMAKE_CURRENT_LIST_DIR}/config.ini
DESTINATION ${CMAKE_INSTALL_DOCDIR}/examples
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 03:34:31 -05: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 12:08:59 -04:00
DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
doc: Install rst based man pages
2018-12-02 13:17:26 -05:00
COMPONENT doc)
doc: Write syntax definition in polybar.5
2019-10-03 16:42:47 -04:00
Install manpage for polybar-msg
2022-01-24 07:26:58 -05:00
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/polybar-msg.1
DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
COMPONENT doc)
doc: Write syntax definition in polybar.5
2019-10-03 16:42:47 -04:00
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/polybar.5
DESTINATION ${CMAKE_INSTALL_MANDIR}/man5
COMPONENT doc)
Copy permalink