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. --- docs/module/ECMAddTests.rst | 1 + docs/module/ECMCreateQmFromPoFiles.rst | 1 + docs/module/ECMDBusAddActivationService.rst | 1 + docs/module/ECMFindModuleHelpers.rst | 1 + docs/module/ECMGenerateHeaders.rst | 1 + docs/module/ECMGeneratePriFile.rst | 1 + docs/module/ECMInstallIcons.rst | 1 + docs/module/ECMMarkAsTest.rst | 1 + docs/module/ECMMarkNonGuiExecutable.rst | 1 + docs/module/ECMOptionalAddSubdirectory.rst | 1 + docs/module/ECMPackageConfigHelpers.rst | 1 + docs/module/ECMSetupVersion.rst | 1 + docs/module/ECMUseFindModules.rst | 1 + 13 files changed, 13 insertions(+) create mode 100644 docs/module/ECMAddTests.rst create mode 100644 docs/module/ECMCreateQmFromPoFiles.rst create mode 100644 docs/module/ECMDBusAddActivationService.rst create mode 100644 docs/module/ECMFindModuleHelpers.rst create mode 100644 docs/module/ECMGenerateHeaders.rst create mode 100644 docs/module/ECMGeneratePriFile.rst create mode 100644 docs/module/ECMInstallIcons.rst create mode 100644 docs/module/ECMMarkAsTest.rst create mode 100644 docs/module/ECMMarkNonGuiExecutable.rst create mode 100644 docs/module/ECMOptionalAddSubdirectory.rst create mode 100644 docs/module/ECMPackageConfigHelpers.rst create mode 100644 docs/module/ECMSetupVersion.rst create mode 100644 docs/module/ECMUseFindModules.rst (limited to 'docs/module') diff --git a/docs/module/ECMAddTests.rst b/docs/module/ECMAddTests.rst new file mode 100644 index 00000000..f971953a --- /dev/null +++ b/docs/module/ECMAddTests.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMAddTests.cmake diff --git a/docs/module/ECMCreateQmFromPoFiles.rst b/docs/module/ECMCreateQmFromPoFiles.rst new file mode 100644 index 00000000..13340c0a --- /dev/null +++ b/docs/module/ECMCreateQmFromPoFiles.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMCreateQmFromPoFiles.cmake diff --git a/docs/module/ECMDBusAddActivationService.rst b/docs/module/ECMDBusAddActivationService.rst new file mode 100644 index 00000000..2052faeb --- /dev/null +++ b/docs/module/ECMDBusAddActivationService.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMDBusAddActivationService.cmake diff --git a/docs/module/ECMFindModuleHelpers.rst b/docs/module/ECMFindModuleHelpers.rst new file mode 100644 index 00000000..bec8f822 --- /dev/null +++ b/docs/module/ECMFindModuleHelpers.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMFindModuleHelpers.cmake diff --git a/docs/module/ECMGenerateHeaders.rst b/docs/module/ECMGenerateHeaders.rst new file mode 100644 index 00000000..ad3e4819 --- /dev/null +++ b/docs/module/ECMGenerateHeaders.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMGenerateHeaders.cmake diff --git a/docs/module/ECMGeneratePriFile.rst b/docs/module/ECMGeneratePriFile.rst new file mode 100644 index 00000000..1cb4d6a4 --- /dev/null +++ b/docs/module/ECMGeneratePriFile.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMGeneratePriFile.cmake diff --git a/docs/module/ECMInstallIcons.rst b/docs/module/ECMInstallIcons.rst new file mode 100644 index 00000000..7bb70ea5 --- /dev/null +++ b/docs/module/ECMInstallIcons.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMInstallIcons.cmake diff --git a/docs/module/ECMMarkAsTest.rst b/docs/module/ECMMarkAsTest.rst new file mode 100644 index 00000000..8b6a8752 --- /dev/null +++ b/docs/module/ECMMarkAsTest.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMMarkAsTest.cmake diff --git a/docs/module/ECMMarkNonGuiExecutable.rst b/docs/module/ECMMarkNonGuiExecutable.rst new file mode 100644 index 00000000..2684fee6 --- /dev/null +++ b/docs/module/ECMMarkNonGuiExecutable.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMMarkNonGuiExecutable.cmake diff --git a/docs/module/ECMOptionalAddSubdirectory.rst b/docs/module/ECMOptionalAddSubdirectory.rst new file mode 100644 index 00000000..af9595ec --- /dev/null +++ b/docs/module/ECMOptionalAddSubdirectory.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMOptionalAddSubdirectory.cmake diff --git a/docs/module/ECMPackageConfigHelpers.rst b/docs/module/ECMPackageConfigHelpers.rst new file mode 100644 index 00000000..21102c4f --- /dev/null +++ b/docs/module/ECMPackageConfigHelpers.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMPackageConfigHelpers.cmake diff --git a/docs/module/ECMSetupVersion.rst b/docs/module/ECMSetupVersion.rst new file mode 100644 index 00000000..f984a81f --- /dev/null +++ b/docs/module/ECMSetupVersion.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMSetupVersion.cmake diff --git a/docs/module/ECMUseFindModules.rst b/docs/module/ECMUseFindModules.rst new file mode 100644 index 00000000..48bbf35a --- /dev/null +++ b/docs/module/ECMUseFindModules.rst @@ -0,0 +1 @@ +.. ecm-module:: ../../modules/ECMUseFindModules.cmake -- cgit v1.2.1