From c20d22c951e61a06701f6c2201add7c11915e7c5 Mon Sep 17 00:00:00 2001 From: Alex Merry Date: Thu, 10 Apr 2014 21:38:09 +0100 Subject: Add documentation generation using Sphinx This is deliberately modelled very closely on CMake's documentation system. It's a hefty patch, because it involved changing all the documentation to be in reStructuredText format. I also cleaned up the copyright/license statements at the same time. Note that the find modules contain the full license, due to the fact that ecm_use_find_module() copies them out of the ECM distribution. --- kde-modules/KDECMakeSettings.cmake | 74 +++++++++++++++++++++++--------------- 1 file changed, 46 insertions(+), 28 deletions(-) (limited to 'kde-modules/KDECMakeSettings.cmake') diff --git a/kde-modules/KDECMakeSettings.cmake b/kde-modules/KDECMakeSettings.cmake index 3f675519..c206ff82 100644 --- a/kde-modules/KDECMakeSettings.cmake +++ b/kde-modules/KDECMakeSettings.cmake @@ -1,46 +1,64 @@ -# Change various CMake settings to what the KDE community views as more +#.rst: +# KDECMakeSettings +# ---------------- +# +# Changes various CMake settings to what the KDE community views as more # sensible defaults. # -# It is split into three parts, which can be independently disabled if -# desired. +# It is split into three parts, which can be independently disabled if desired. +# +# Runtime Paths +# ~~~~~~~~~~~~~ # -# RPATH +# The default runtime path (used on Unix systems to search for +# dynamically-linked libraries) is set to include the location that libraries +# will be installed to (as set in LIB_INSTALL_DIR), and also the linker search +# path. # -# The default runtime path (used on Unix systems to search for -# dynamically-linked libraries) is set to include the location that -# libraries will be installed to (as set in LIB_INSTALL_DIR), and also -# the linker search path. +# Note that ``LIB_INSTALL_DIR`` needs to be set before including this module. +# Typically, this is done by including the :kde-module:`KDEInstallDirs` module. # -# Note that LIB_INSTALL_DIR needs to be set before including this -# module. Typically, this is done by including the KDEInstallDirs -# module. +# This section can be disabled by setting ``KDE_SKIP_RPATH_SETTINGS`` to TRUE +# before including this module. # -# This section can be disabled by setting -# KDE_SKIP_RPATH_SETTINGS -# to TRUE before including this module. # +# Testing +# ~~~~~~~ # -# TEST +# Testing is enabled by default, and an option (BUILD_TESTING) is provided for +# users to control this. See the CTest module documentation in the CMake manual +# for more details. # -# Testing is enabled by default, and an option (BUILD_TESTING) is -# provided for users to control this. See the CTest module -# documentation in the CMake manual for more details. +# This section can be disabled by setting ``KDE_SKIP_TEST_SETTINGS`` to TRUE +# before including this module. # -# This section can be disabled by setting -# KDE_SKIP_TEST_SETTINGS -# to TRUE before including this module. # +# Build Settings +# ~~~~~~~~~~~~~~ # -# BUILD +# Various CMake build defaults are altered, such as searching source and build +# directories for includes first and enabling automoc by default. # -# Various CMake build defaults are altered, such as searching source -# and build directories for includes first and enabling automoc by -# default. +# This section can be disabled by setting ``KDE_SKIP_BUILD_SETTINGS`` to TRUE +# before including this module. + +#============================================================================= +# Copyright 2014 Alex Merry +# Copyright 2013 Aleix Pol +# Copyright 2012-2013 Stephen Kelly +# Copyright 2007 Matthias Kretz +# Copyright 2006-2007 Laurent Montel +# Copyright 2006-2013 Alex Neundorf # -# This section can be disabled by setting -# KDE_SKIP_BUILD_SETTINGS -# to TRUE before including this module. +# Distributed under the OSI-approved BSD License (the "License"); +# see accompanying file COPYING-CMAKE-SCRIPTS for details. # +# This software is distributed WITHOUT ANY WARRANTY; without even the +# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# See the License for more information. +#============================================================================= +# (To distribute this file outside of extra-cmake-modules, substitute the full +# License text for the above reference.) ################# RPATH handling ################################## -- cgit v1.2.1