spl-core 8.1.2__tar.gz → 9.0.0rc1.dev1__tar.gz

{spl_core-8.1.2 → spl_core-9.0.0rc1.dev1}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: spl-core
-Version: 8.1.2
+Version: 9.0.0rc1.dev1
 Summary: Software Product Line Support for CMake
 License: MIT
 License-File: LICENSE
 Author: Avengineers
 Author-email: karsten.guenther@kamg.de
-Requires-Python: >=3.10,<3.12
+Requires-Python: >=3.10,<3.14
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -15,17 +15,19 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries
+Requires-Dist: clanguru (>=0,<1)
 Requires-Dist: cookiecutter (==2.7.1)
-Requires-Dist: doxysphinx (>=3.3,<4.0)
 Requires-Dist: gcovr (>=8.6,<9.0)
 Requires-Dist: hammocking (>=1.0,<2.0)
-Requires-Dist: junitparser (>=5.0,<6.0)
+Requires-Dist: junitparser
 Requires-Dist: kconfiglib (>=14.1,<15.0)
 Requires-Dist: mlx-traceability (>=10,<12)
 Requires-Dist: myst-parser (>=0.16)
 Requires-Dist: py-app-dev (>=2.1,<3.0)
-Requires-Dist: py7zr (>=1.0,<2.0)
+Requires-Dist: py7zr (>=1.1.0,<2.0.0)
 Requires-Dist: pypeline-runner (>=1,<=2)
 Requires-Dist: pypeline-semantic-release (>=0.5,<1.0)
 Requires-Dist: sphinx (>=7.3,<9.0)

{spl_core-8.1.2 → spl_core-9.0.0rc1.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "spl-core"
-version = "8.1.2"
+version = "9.0.0-rc1.dev.1"
 description = "Software Product Line Support for CMake"
 authors = ["Avengineers <karsten.guenther@kamg.de>"]
 license = "MIT"
@@ -25,14 +25,14 @@ junit_merger = "spl_core.test_utils.junit_merger:main"
 "Changelog" = "https://github.com/avengineers/spl-core/blob/develop/CHANGELOG.md"
 
 [tool.poetry.dependencies]
-python = ">=3.10,<3.12"
+python = ">=3.10,<3.14"
 py-app-dev = "^2.1"
 cookiecutter = "==2.7.1"
 gcovr = "^8.6"
 hammocking = "^1.0"
+clanguru = ">=0,<1"
 kconfiglib = "^14.1"
 typer = ">=0,<1"
-doxysphinx = "^3.3"
 sphinx = ">=7.3,<9.0"
 sphinx-rtd-theme = ">=2,<4"
 sphinxcontrib-mermaid = ">=0.9,<2.1"
@@ -49,8 +49,8 @@ sphinx-book-theme = "^1.1"
 sphinx-design = ">=0.5,<0.7"
 pypeline-semantic-release = ">=0.5,<1.0"
 pypeline-runner = ">=1,<=2"
-py7zr = "^1.0"
-junitparser = "^5.0"
+py7zr = "^1.1.0"
+junitparser = "*"
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7,<10"
@@ -106,7 +106,7 @@ exclude_lines = [
 ]
 
 [tool.ruff]
-target-version = "py38"
+target-version = "py313"
 line-length = 220
 lint.ignore = [
     "D203", # 1 blank line required before class docstring

spl_core-9.0.0rc1.dev1/src/spl_core/__init__.py

@@ -0,0 +1 @@
+__version__ = "9.0.0-rc1.dev.1"

{spl_core-8.1.2 → spl_core-9.0.0rc1.dev1}/src/spl_core/common.cmake

@@ -1,20 +1,3 @@
-# Option to run doxysphinx in sequential mode (avoids crashes on some systems).
-# Can be set via:
-# 1. CMake option:        -DSPL_DOXYSPHINX_SEQUENTIAL=ON
-# 2. Environment variable: SPL_DOXYSPHINX_SEQUENTIAL=ON (no project file changes needed)
-# The environment variable takes precedence if set.
-if(DEFINED ENV{SPL_DOXYSPHINX_SEQUENTIAL})
-    set(SPL_DOXYSPHINX_SEQUENTIAL "$ENV{SPL_DOXYSPHINX_SEQUENTIAL}" CACHE BOOL "Run doxysphinx build with --sequential option" FORCE)
-endif()
-
-option(SPL_DOXYSPHINX_SEQUENTIAL "Run doxysphinx build with --sequential option" OFF)
-
-if(SPL_DOXYSPHINX_SEQUENTIAL)
-    set(SPL_DOXYSPHINX_EXTRA_ARGS "--sequential")
-else()
-    set(SPL_DOXYSPHINX_EXTRA_ARGS "")
-endif()
-
 macro(_spl_slash_to_underscore out in)
     string(REGEX REPLACE "/" "_" ${out} ${in})
 endmacro()
@@ -319,6 +302,13 @@ macro(spl_create_component)
             _spl_add_test_suite(${component_name} "${SOURCES}" "${TEST_SOURCES}")
         endif()
 
+        # Generate source documentation using clanguru
+        set(_COMPONENT_SOURCE_DOCS_INCLUDE_PATTERN "")
+        set(_clanguru_all_sources ${SOURCES} ${TEST_SOURCES})
+        if(_clanguru_all_sources)
+            _spl_generate_clanguru_source_docs(${component_name} "${_clanguru_all_sources}")
+        endif()
+
         set(_component_dir ${CMAKE_CURRENT_LIST_DIR})
         set(_component_doc_dir ${_component_dir}/doc)
         set(_component_test_junit_xml ${CMAKE_CURRENT_BINARY_DIR}/junit.xml)
@@ -401,27 +391,13 @@ Code Coverage
 
 ")
 
-                # generate Doxyfile from template
-                set(_component_doxyfile ${_component_reports_out_dir}/Doxyfile)
-                set(DOXYGEN_PROJECT_NAME "${CREATE_COMPONENT_LONG_NAME} Documentation")
-                set(DOXYGEN_OUTPUT_DIRECTORY ${_component_reports_out_dir}/doxygen)
-                set(DOXYGEN_INPUT "${_component_dir}/src ${_component_dir}/test ${KCONFIG_OUT_DIR}")
-
-                # We need to add the googletest include directory to the doxygen include path
-                # to be able to resolve the TEST() macros in the test files.
-                set(DOXYGEN_INCLUDE_PATH "${_sphinx_source_dir}/build/modules/googletest-src/googletest/include ${KCONFIG_OUT_DIR}")
-                set(DOXYGEN_AWESOME_PATH "${_sphinx_source_dir}/doc/doxygen-awesome")
-                configure_file(${_sphinx_source_dir}/doc/Doxyfile.in ${_component_doxyfile} @ONLY)
-                file(RELATIVE_PATH _rel_component_doxyfile ${CMAKE_CURRENT_BINARY_DIR} ${_component_doxyfile})
-                file(RELATIVE_PATH _rel_component_doxysphinx_index_rst ${_sphinx_source_dir} ${DOXYGEN_OUTPUT_DIRECTORY}/html/index)
-
                 file(WRITE ${_reports_config_json} "{
     \"component_info\": ${_component_info},
     \"include_patterns\": [\"${_rel_component_doc_dir}/**\",\"${_rel_component_reports_out_dir}/**\"]
 }")
 
                 # add the generated files as dependency to cmake configure step
-                set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS ${_reports_config_json} ${_unit_test_spec_rst} ${_unit_test_results_rst} ${_component_doxyfile})
+                set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS ${_reports_config_json} ${_unit_test_spec_rst} ${_unit_test_results_rst})
 
                 set(_cov_out_html reports/html/${_rel_component_reports_out_dir}/coverage/index.html)
                 file(RELATIVE_PATH _cov_out_json ${CMAKE_CURRENT_BINARY_DIR} ${_component_coverage_json})
@@ -435,32 +411,22 @@ Code Coverage
                     COMMENT "Generating component coverage html report ${_cov_out_html} ..."
                 )
 
-                # We need to have a separate component doxygen generation target because it is required
-                # by both the component and variant reports.
-                add_custom_target(
-
-                    # No OUTPUT is defined to force execution of this target every time
-                    ${component_name}_doxygen
-                    COMMAND ${CMAKE_COMMAND} -E make_directory ${_component_reports_out_dir}
-                    COMMAND ${CMAKE_COMMAND} -E remove_directory ${DOXYGEN_OUTPUT_DIRECTORY}
-                    COMMAND ${CMAKE_COMMAND} -E make_directory ${DOXYGEN_OUTPUT_DIRECTORY}
-                    COMMAND doxygen ${_rel_component_doxyfile}
-                )
-
                 # No OUTPUT is defined to force execution of this target every time
                 # TODO: list of dependencies is not complete
                 add_custom_target(
                     ${component_name}_report
                     COMMAND ${CMAKE_COMMAND} -E make_directory ${_component_reports_out_dir}
-                    COMMAND doxysphinx build ${_sphinx_source_dir} ${_component_reports_html_out_dir} ${_rel_component_doxyfile} ${SPL_DOXYSPHINX_EXTRA_ARGS}
                     COMMAND ${CMAKE_COMMAND} -E env SPHINX_BUILD_CONFIGURATION_FILE=${_reports_config_json} AUTOCONF_JSON_FILE=${AUTOCONF_JSON} VARIANT=${VARIANT} -- sphinx-build -E -b html ${_sphinx_source_dir} ${_component_reports_html_out_dir}
                     BYPRODUCTS ${_component_reports_html_out_dir}/index.html
-                    DEPENDS ${TEST_OUT_JUNIT} ${component_name}_doxygen ${_cov_out_html}
+                    DEPENDS ${TEST_OUT_JUNIT} ${_cov_out_html}
                 )
             endif(TEST_SOURCES)
 
             # Collect all component sphinx include pattern to be used in the variant targets (docs, reports)
             list(APPEND COMPONENTS_SPHINX_INCLUDE_PATTERNS "${_rel_component_doc_dir}/**" "${_rel_component_docs_out_dir}/**" "${_rel_component_reports_out_dir}/**")
+            if(_COMPONENT_SOURCE_DOCS_INCLUDE_PATTERN)
+                list(APPEND COMPONENTS_SPHINX_INCLUDE_PATTERNS "${_COMPONENT_SOURCE_DOCS_INCLUDE_PATTERN}")
+            endif()
             set(COMPONENTS_SPHINX_INCLUDE_PATTERNS ${COMPONENTS_SPHINX_INCLUDE_PATTERNS} PARENT_SCOPE)
         endif(EXISTS ${_component_doc_dir}/index.rst OR EXISTS ${_component_doc_dir}/index.md)
     endif(BUILD_KIT STREQUAL prod)
@@ -562,10 +528,8 @@ Code Coverage
 
 ")
 
-    # For every component we need to create specific coverage and doxysphinx targets to make sure
+    # For every component we need to create specific coverage targets to make sure
     # the output files are generated in the overall variant sphinx output directory.
-    # This will avoid the need to copy all the component coverage and doxygen files from the component
-    # directories to the variant directory.
     foreach(component_info ${COMPONENTS_INFO})
         string(JSON component_name GET ${component_info} name)
         string(JSON component_path GET ${component_info} path)
@@ -583,15 +547,6 @@ Code Coverage
             )
             list(APPEND _components_coverage_html ${_cov_out_html})
 
-            set(_rel_component_doxyfile ${component_path}/reports/Doxyfile)
-            add_custom_target(
-                ${component_name}_doxysphinx
-                COMMAND ${CMAKE_COMMAND} -E make_directory ${_variant_component_reports_out_dir}
-                COMMAND doxysphinx build ${PROJECT_SOURCE_DIR} ${_reports_html_output_dir} ${_rel_component_doxyfile} ${SPL_DOXYSPHINX_EXTRA_ARGS}
-                DEPENDS ${component_name}_doxygen
-                COMMENT "Generating variant component doxysphinx report ${component_name}_doxysphinx ..."
-            )
-            list(APPEND _components_variant_doxysphinx_targets ${component_name}_doxysphinx)
         endif()
     endforeach()
 
@@ -623,7 +578,7 @@ Code Coverage
         # We need to call sphinx-build with -E to make sure all files are regenerated.
         COMMAND ${CMAKE_COMMAND} -E env SPHINX_BUILD_CONFIGURATION_FILE=${_reports_config_json} AUTOCONF_JSON_FILE=${AUTOCONF_JSON} VARIANT=${VARIANT} -- sphinx-build -E -b html ${PROJECT_SOURCE_DIR} ${_reports_html_output_dir}
         BYPRODUCTS ${_reports_html_output_dir}/index.html
-        DEPENDS ${JUNIT_OUT_VARIANT_XML} ${COV_OUT_VARIANT_JSON} _components_variant_coverage_html_target ${_components_variant_doxysphinx_targets}
+        DEPENDS ${JUNIT_OUT_VARIANT_XML} ${COV_OUT_VARIANT_JSON} _components_variant_coverage_html_target source_docs
     )
 endmacro()
 
@@ -835,6 +790,49 @@ macro(_spl_add_test_suite COMPONENT_NAME PROD_SRC TEST_SOURCES)
     )
 endmacro(_spl_add_test_suite)
 
+macro(_spl_generate_clanguru_source_docs COMPONENT_NAME SRC_FILES)
+    if(NOT CLANGURU_EXECUTABLE)
+        find_program(CLANGURU_EXECUTABLE clanguru)
+    endif()
+    if(NOT CLANGURU_EXECUTABLE)
+        message(WARNING "clanguru not found, skipping source documentation generation")
+        return()
+    endif()
+
+    set(_clanguru_docs_out_dir ${CMAKE_CURRENT_BINARY_DIR}/source_docs)
+    set(_clanguru_doc_outputs "")
+    foreach(_src_file ${SRC_FILES})
+        get_filename_component(_src_name ${_src_file} NAME)
+        set(_doc_output ${_clanguru_docs_out_dir}/${_src_name}.rst)
+        add_custom_command(
+            OUTPUT ${_doc_output}
+            COMMAND ${CMAKE_COMMAND} -E make_directory ${_clanguru_docs_out_dir}
+            COMMAND ${CLANGURU_EXECUTABLE} docs
+                --source-file ${_src_file}
+                --output-file ${_doc_output}
+                --compilation-database ${CLANGURU_COMPILE_COMMANDS}
+                --format rst
+            # Strip @rst/@endrst markers from generated RST so Sphinx can process directives directly
+            COMMAND python -c "import pathlib,re$<SEMICOLON> p=pathlib.Path(r'${_doc_output}')$<SEMICOLON> p.write_text(re.sub(r'(?m)^\\s*@(?:end)?rst\\s*$$','',p.read_text(encoding='utf-8')),encoding='utf-8')"
+            DEPENDS ${_src_file}
+            COMMENT "Generating RST docs for ${_src_name} (${COMPONENT_NAME})"
+        )
+        list(APPEND _clanguru_doc_outputs ${_doc_output})
+    endforeach()
+
+    if(_clanguru_doc_outputs)
+        add_custom_target(
+            ${COMPONENT_NAME}_source_docs
+            DEPENDS ${_clanguru_doc_outputs}
+        )
+        add_dependencies(source_docs ${COMPONENT_NAME}_source_docs)
+
+        # Expose source_docs directory for Sphinx include patterns
+        file(RELATIVE_PATH _rel_clanguru_docs_out_dir ${PROJECT_SOURCE_DIR} ${_clanguru_docs_out_dir})
+        set(_COMPONENT_SOURCE_DOCS_INCLUDE_PATTERN "${_rel_clanguru_docs_out_dir}/**")
+    endif()
+endmacro(_spl_generate_clanguru_source_docs)
+
 macro(spl_add_conan_requires requirement)
     list(APPEND CONAN__REQUIRES ${requirement})
 endmacro(spl_add_conan_requires)