From 6ffc9c4fec072becb2ccc21f3c80c56b8aa79098 Mon Sep 17 00:00:00 2001 From: R Kent James Date: Thu, 18 Apr 2024 11:43:45 -0700 Subject: [PATCH] Set STRIP_FROM_PATH in Doxyfile (#111) --- .../verbs/build/builders/doxygen_builder.py | 1 + test/test_builder.py | 21 ++++++++++++------- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/rosdoc2/verbs/build/builders/doxygen_builder.py b/rosdoc2/verbs/build/builders/doxygen_builder.py index ff316e5d..6d45dd03 100644 --- a/rosdoc2/verbs/build/builders/doxygen_builder.py +++ b/rosdoc2/verbs/build/builders/doxygen_builder.py @@ -38,6 +38,7 @@ MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES +STRIP_FROM_PATH = {package_directory} """ EXTENDED_DOXYFILE = """\ diff --git a/test/test_builder.py b/test/test_builder.py index 2c8cec94..4af67e59 100644 --- a/test/test_builder.py +++ b/test/test_builder.py @@ -85,7 +85,7 @@ def do_test_package( file_excludes=[], links_exist=[], fragments=[], -) -> None: +) -> htmlParser: """Test that package documentation exists and includes/excludes certain text. :param pathlib.Path work_path: path where generated files were placed @@ -169,6 +169,8 @@ def do_test_package( assert found_fragment, \ f'html should have text fragment <{item}>' + return parser + def test_minimum_package(session_dir): """Tests of a package containing as little as possible.""" @@ -228,12 +230,17 @@ def test_full_package(session_dir): fragments = [ 'this is the package readme.', ] - do_test_package(PKG_NAME, session_dir, - includes=includes, - file_includes=file_includes, - excludes=excludes, - links_exist=links_exist, - fragments=fragments) + parser = do_test_package(PKG_NAME, session_dir, + includes=includes, + file_includes=file_includes, + excludes=excludes, + links_exist=links_exist, + fragments=fragments) + + # We don't want the parent directories to appear + for item in parser.links: + assert 'rosdoc2_test_packages' not in item, \ + f'Found link {item} should not contain parent rosdoc2_test_packages' def test_only_python(session_dir):