Docs: Add docs target

FairRootGroup · May 21, 2021 · c34068a · c34068a
1 parent 6666e2f
commit c34068a
Show file tree

Hide file tree

Showing 20 changed files with 981 additions and 149 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+__pycache__
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -0,0 +1,32 @@
+*********
+Changelog
+*********
+.. View rendered on https://fairrootgroup.github.io/FairCMakeModules/latest/changelog.html
+
+Unreleased
+==========
+
+Changed
+-------
+
+* :command:`find_package2`'s option ``ADD_REQUIREMENTS_OF`` is now a no-op. All
+  known requirements are merged by default.
+
+New
+---
+
+* In module :module:`FairFindPackage2`
+
+  * List FairCMakeModules as package dependency
+  * Macro :command:`find_package2_implicit_dependencies`
+  * Function :command:`fair_generate_package_dependencies`
+
+* Module :module:`FairFormattedOutput`
+
+**v0.1.0 (beta)** 2021-04-24
+============================
+
+New
+---
+
+* Module :module:`FairFindPackage2`
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -13,6 +13,10 @@ project(FairCMakeModules VERSION 0.1.0 LANGUAGES CXX
         HOMEPAGE_URL "https://github.com/FairRootGroup/FairCMakeModules")
 message(STATUS "${PROJECT_NAME} Version ${PROJECT_VERSION}")
 
+if(NOT CMAKE_BUILD_TYPE)
+  set(CMAKE_BUILD_TYPE Release)
+endif()
+
 include(GNUInstallDirs)
 include(CMakePackageConfigHelpers)
 include(CTest)
@@ -28,6 +32,11 @@ set(PROJECT_INSTALL_MODULESDIR "${PROJECT_INSTALL_DATADIR}/modules")
 add_subdirectory(src)
 add_subdirectory(tests)
 
+find_program(SPHINX_EXECUTABLE NAMES sphinx-build)
+if(SPHINX_EXECUTABLE)
+  add_subdirectory(docs)
+endif()
+
 configure_package_config_file(
   "cmake/${PROJECT_NAME}Config.cmake.in"
   "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
@@ -49,7 +58,7 @@ install(
 install(
   FILES
     README.md
-    CHANGELOG.md
+    CHANGELOG.rst
   DESTINATION "${CMAKE_INSTALL_DOCDIR}")
 
 

diff --git a/README.md b/README.md
@@ -1,47 +1,5 @@
 # FairCMakeModules
 
-CMake Modules developed in the context of various FAIR projects
+This project maintains CMake Modules developed in the context of various [FAIR](https://www.gsi.de/en/researchaccelerators/fair) software projects.
 
-## Installation
-
-```
-git clone https://github.com/FairRootGroup/FairCMakeModules
-cmake -S FairCMakeModules -B FairCMakeModules_build -DCMAKE_INSTALL_PREFIX=FairCMakeModules_install
-cmake --build FairCMakeModules_build --target install
-```
-
-## Usage
-
-In your project, discover this package with [`find_package`](https://cmake.org/cmake/help/latest/command/find_package.html#full-signature-and-config-mode) (see the official CMake docs for the full call signature of `find_package`):
-
-```
-find_package(FairCMakeModules REQUIRED)
-```
-
-Then [`include`](https://cmake.org/cmake/help/latest/command/include.html) any module you would like to use
-
-```
-include(<modulename>)
-```
-
-Available modules are:
-
-* [FairFindPackage2](src/modules/FairFindPackage2.cmake)
-
-## License
-
-```
-################################################################################
-#    Copyright (C) 2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
-#                                                                              #
-#              This software is distributed under the terms of the             #
-#              GNU Lesser General Public Licence (LGPL) version 3,             #
-#                  copied verbatim in the file "LICENSE"                       #
-################################################################################
-```
-
-## Contributing
-
-For comments, questions, and bug reports please [open a github issue](https://github.com/FairRootGroup/FairCMakeModules/issues/new).
-
-For code contributions and bug fixes please create [a github pull request](https://github.com/FairRootGroup/FairCMakeModules/pulls) against the `main` branch. Read our [notes for developers](docs/development.md).
+:pushpin: **Get started by visiting the [:closed_book: Documentation](https://fairrootgroup.github.io/FairCMakeModules/)**
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -0,0 +1,20 @@
+################################################################################
+#    Copyright (C) 2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    #
+#                                                                              #
+#              This software is distributed under the terms of the             #
+#              GNU Lesser General Public Licence (LGPL) version 3,             #
+#                  copied verbatim in the file "LICENSE"                       #
+################################################################################
+
+configure_file(conf.py.in
+  "${CMAKE_CURRENT_BINARY_DIR}/conf.py" @ONLY
+)
+
+set(builder html)
+add_custom_target(docs
+  COMMAND ${SPHINX_EXECUTABLE} -a -E -c "${CMAKE_CURRENT_BINARY_DIR}" -b ${builder}
+          ${CMAKE_CURRENT_SOURCE_DIR} "${CMAKE_CURRENT_BINARY_DIR}/${builder}"
+  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+  COMMENT "Generating documentation"
+  VERBATIM
+)
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1,2 @@
+.. default-domain:: cmake
+.. include:: ../CHANGELOG.rst
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.. default-domain:: cmake
		.. include:: ../CHANGELOG.rst