documentation action modified to publish greeter

the documentation action was modified alongwith the docs directory so as to publish the greeter library docs.
amolgawai · Apr 24, 2022 · 3272516 · 3272516
1 parent 8a6c7f4
commit 3272516
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 16 deletions.
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -34,4 +34,4 @@ jobs:
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./build/doxygen/html
+          publish_dir: ./build/libs/greeter/docs/doxygen/html
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -31,11 +31,6 @@ if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
   include(CTest)
   # include(CMakePrintHelpers) Docs only available if this is the main app
   find_package(Doxygen)
-  if(Doxygen_FOUND)
-    add_subdirectory(docs)
-  else()
-    message(STATUS "Doxygen not found, not building docs")
-  endif()
 endif()
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

diff --git a/libs/greeter/CMakeLists.txt b/libs/greeter/CMakeLists.txt
@@ -1,5 +1,11 @@
 cmake_minimum_required(VERSION 3.23 FATAL_ERROR)
 
+if(Doxygen_FOUND)
+  add_subdirectory(docs)
+else()
+  message(STATUS "Doxygen not found, not building docs")
+endif()
+
 # ---- Add source files ----
 
 # Note: globbing sources is considered bad practice as CMake's generators may not detect new files

diff --git a/libs/greeter/README.md b/libs/greeter/README.md
@@ -0,0 +1,3 @@
+# Greeter demo library
+
+Greeter demo library for the modern-cpp-project
diff --git a/docs/CMakeLists.txt → libs/greeter/docs/CMakeLists.txt b/docs/CMakeLists.txt → libs/greeter/docs/CMakeLists.txt
@@ -3,11 +3,7 @@ cmake_minimum_required(VERSION 3.23 FATAL_ERROR)
 # project(GreeterDocs)
 
 # ---- Dependencies ----
-
-include(../cmake/CPM.cmake)
-
-CPMAddPackage("gh:mosra/m.css#42d4a9a48f31f5df6e246c948403b54b50574a2a")
-# CPMAddPackage(NAME greeter SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..)
+CPMAddPackage("gh:mosra/m.css#a0d292ec311b97fefd21e93cdefb60f88d19ede6")
 
 # ---- Doxygen variables ----
 

diff --git a/docs/Doxyfile → libs/greeter/docs/Doxyfile b/docs/Doxyfile → libs/greeter/docs/Doxyfile
diff --git a/docs/conf.py → libs/greeter/docs/conf.py b/docs/conf.py → libs/greeter/docs/conf.py
@@ -1,9 +1,6 @@
-DOXYFILE = 'Doxyfile'
+DOXYFILE = "Doxyfile"
 
-LINKS_NAVBAR1 = [
-    (None, 'pages', [(None, 'about')]),
-    (None, 'namespaces', []),
-]
+LINKS_NAVBAR1 = [("Pages", "pages", []), ("Namespaces", "namespaces", [])]
 
 # Add your own navbar links using the code below.
 # To find the valid link names, you can inspect the URL of a generated documentation site.

diff --git a/docs/pages/about.dox → libs/greeter/docs/pages/about.dox b/docs/pages/about.dox → libs/greeter/docs/pages/about.dox
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Greeter demo library

		Greeter demo library for the modern-cpp-project