update docs

CMakeLists.txt

@@ -33,7 +33,7 @@ endif()
 
 option(BUILD_TESTS "Uses googletest to build tests" OFF)
 option(BUILD_INTEGRATION_TESTS "Include integration tests (CMAKE >3.7 is needed)" OFF)
-option(BUILD_DOCS "Uses doxygen to build the documentaion" OFF)
+option(BUILD_CPP_DOCS "Uses doxygen to build the C++ documentaion" OFF)
 option(BUILD_BROKER "Build broker" OFF)
 option(BUILD_PYTHON_DOCS "Uses sphinx to build the Python documentaion" OFF)
 
@@ -85,7 +85,6 @@ add_subdirectory(asapo_tools)
 
 add_subdirectory(deploy)
 
-
 if(BUILD_INTEGRATION_TESTS)
     add_subdirectory(tests)
 endif()
@@ -94,17 +93,6 @@ if(BUILD_EXAMPLES)
     add_subdirectory(examples)
 endif()
 
-if(BUILD_DOCS)
-    include(doxygen)
-endif()
-
-
-if(BUILD_PYTHON_DOCS)
-    add_subdirectory (sphinx)
-endif()
-
-
-
-
+include(prepare_version)
 
-include(prepare_version)
\ No newline at end of file
+add_subdirectory(docs)
\ No newline at end of file

CMakeModules/doxygen.cmake

-find_program(DOXYGEN_EXECUTABLE doxygen)
-if(DOXYGEN_EXECUTABLE)
-    message("Found doxygen. Using doxygen to build documentaion.")
-    add_custom_target(
-            documentation
-            COMMAND
-            ${DOXYGEN_EXECUTABLE} doxygen.ini VERBATIM
-            WORKING_DIRECTORY ..
-    )
-else()
-    message("Unable to find doxygen. Skipping code documentaion.")
-endif()

consumer/api/cpp/include/asapo_consumer.h

+/** @defgroup consumer The Consumer Group
+ *  This is the consumer group
+ *  @{
+ */
+
 #ifndef ASAPO_ASAPO_CONSUMER_H
 #define ASAPO_ASAPO_CONSUMER_H
 
@@ -6,3 +11,6 @@
 #include "common/version.h"
 #include <ostream>
 #endif //ASAPO_ASAPO_CONSUMER_H
+
+
+/** @} */ // end of consumer

docs/CMakeLists.txt

+if(BUILD_CPP_DOCS)
+    add_subdirectory(doxygen)
+endif()
+
+if(BUILD_PYTHON_DOCS)
+    add_subdirectory (sphinx)
+endif()
+

sphinx/CMakeLists.txt → docs/sphinx/CMakeLists.txt

@@ -2,11 +2,11 @@ file(COPY ${CMAKE_CURRENT_SOURCE_DIR} DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
 
 
 add_custom_target(
-        pydoc ALL
+        docs-py ALL
         COMMAND
         make html VERBATIM
         WORKING_DIRECTORY sphinx
 )
 
-add_dependencies(pydoc python-lib2-producer)
-add_dependencies(pydoc python-lib2)
+add_dependencies(docs-py python-lib3-producer)
+add_dependencies(docs-py python-lib3)

sphinx/source/conf.py → docs/sphinx/source/conf.py

@@ -19,8 +19,8 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../../../consumer/api/python'))
-sys.path.insert(0, os.path.abspath('../../../producer/api/python'))
+sys.path.insert(0, os.path.abspath('../../../../consumer/api/python'))
+sys.path.insert(0, os.path.abspath('../../../../producer/api/python'))
 
 
 import asapo_producer
@@ -54,7 +54,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'ASAP::O'
-copyright = u'2019, DESY IT'
+copyright = u'2019-2020, DESY IT'
 author = u'DESY IT'
 
 # The version info for the project you're documenting, acts as replacement for

producer/api/cpp/include/asapo_producer.h

+/** @defgroup producer The Producer Group
+ *  This is the producer group
+ *  @{
+ */
+/** @} */ // end of producer
+
+/**
+* @file asapo_producer.h
+* @ingroup producer
+*/
+
 #ifndef ASAPO_ASAPO_PRODUCER_H
 #define ASAPO_ASAPO_PRODUCER_H
 

producer/api/cpp/include/producer/producer.h

@@ -11,7 +11,7 @@
 namespace asapo {
 
 
-
+/** @ingroup producer */
 class Producer {
   public:
     //! Creates a new producer

sphinx/Makefile

-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = ASAPO
-SOURCEDIR     = source
-BUILDDIR      = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file