aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlex Merry <alex.merry@kde.org>2015-02-06 12:31:05 +0000
committerAlex Merry <alex.merry@kde.org>2015-02-06 12:31:05 +0000
commit98a1ac4bf153581865662bd55fd139844d2de5cd (patch)
tree7de7b8d9f3de0cc7516e922dfa087f845c0b375b /docs
parentce678b32de12e6bb3c2b470111a3fcbadcca3a38 (diff)
downloadextra-cmake-modules-98a1ac4bf153581865662bd55fd139844d2de5cd.tar.gz
extra-cmake-modules-98a1ac4bf153581865662bd55fd139844d2de5cd.tar.bz2
Add Android toolchain module to the documentation.
Diffstat (limited to 'docs')
-rw-r--r--docs/manual/ecm-modules.7.rst16
-rw-r--r--docs/manual/ecm-toolchains.7.rst33
-rw-r--r--docs/sphinx/ecm.py3
-rw-r--r--docs/toolchain/Android.rst1
4 files changed, 47 insertions, 6 deletions
diff --git a/docs/manual/ecm-modules.7.rst b/docs/manual/ecm-modules.7.rst
index 16fd8612..ee0e4638 100644
--- a/docs/manual/ecm-modules.7.rst
+++ b/docs/manual/ecm-modules.7.rst
@@ -11,12 +11,12 @@ Introduction
============
Extra CMake Modules (ECM) provides various modules that provide useful functions
-for CMake scripts. ECM actually provides three types of modules: those that
-extend the functionality of the ``find_package`` command are documented in
-:manual:`ecm-find-modules(7)`; those that provide standard settings for software
-produced by the KDE community are documented in :manual:`ecm-kde-modules(7)`.
-The rest provide macros and functions for general use by CMake scripts and are
-documented here.
+for CMake scripts. ECM actually provides three types of modules that can be
+used from CMake scripts: those that extend the functionality of the
+``find_package`` command are documented in :manual:`ecm-find-modules(7)`; those
+that provide standard settings for software produced by the KDE community are
+documented in :manual:`ecm-kde-modules(7)`. The rest provide macros and
+functions for general use by CMake scripts and are documented here.
To use these modules, you need to tell CMake to find the ECM package, and
then add either ``${ECM_MODULE_PATH}`` or ``${ECM_MODULE_DIR}`` to the
@@ -30,6 +30,10 @@ then add either ``${ECM_MODULE_PATH}`` or ``${ECM_MODULE_DIR}`` to the
Using ``${ECM_MODULE_PATH}`` will also make the find modules and KDE modules
available.
+Note that there are also toolchain modules, documented in
+:manual:`ecm-toolchains(7)`, but these are used by users building the software
+rather than developers writing CMake scripts.
+
All Modules
===========
diff --git a/docs/manual/ecm-toolchains.7.rst b/docs/manual/ecm-toolchains.7.rst
new file mode 100644
index 00000000..66f685e2
--- /dev/null
+++ b/docs/manual/ecm-toolchains.7.rst
@@ -0,0 +1,33 @@
+.. ecm-manual-description: ECM Toolchains Reference
+
+ecm-toolchains(7)
+*****************
+
+.. only:: html or latex
+
+ .. contents::
+
+Introduction
+============
+
+Extra CMake Modules (ECM) provides some toolchain modules. Unlike normal
+modules, these are not included directly in projects, but specified with
+the ``CMAKE_TOOLCHAIN_FILE`` cache variable on the commandline.
+
+
+All Modules
+===========
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ /toolchain/*
+
+.. only:: man
+
+ See Also
+ ========
+
+ :manual:`ecm(7)`
+
diff --git a/docs/sphinx/ecm.py b/docs/sphinx/ecm.py
index 3eb75248..ed966bfb 100644
--- a/docs/sphinx/ecm.py
+++ b/docs/sphinx/ecm.py
@@ -154,6 +154,7 @@ _ecm_index_objs = {
'module': _ecm_index_entry('module'),
'find-module': _ecm_index_entry('find-module'),
'kde-module': _ecm_index_entry('kde-module'),
+ 'toolchain': _ecm_index_entry('toolchain'),
}
def _ecm_object_inventory(env, document, line, objtype, targetid):
@@ -264,6 +265,7 @@ class ECMDomain(Domain):
'kde-module': ObjType('kde-module', 'kde-module'),
'find-module': ObjType('find-module', 'find-module'),
'manual': ObjType('manual', 'manual'),
+ 'toolchain': ObjType('toolchain', 'toolchain'),
}
directives = {}
roles = {
@@ -271,6 +273,7 @@ class ECMDomain(Domain):
'kde-module': XRefRole(),
'find-module': XRefRole(),
'manual': XRefRole(),
+ 'toolchain': XRefRole(),
}
initial_data = {
'objects': {}, # fullname -> docname, objtype
diff --git a/docs/toolchain/Android.rst b/docs/toolchain/Android.rst
new file mode 100644
index 00000000..9103e622
--- /dev/null
+++ b/docs/toolchain/Android.rst
@@ -0,0 +1 @@
+.. ecm-module:: ../../toolchain/Android.cmake