Skip to content

Commit

Permalink
Set STRIP_FROM_PATH in Doxyfile (#111)
Browse files Browse the repository at this point in the history
  • Loading branch information
rkent authored Apr 18, 2024
1 parent b88a0a0 commit 6ffc9c4
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
1 change: 1 addition & 0 deletions rosdoc2/verbs/build/builders/doxygen_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
STRIP_FROM_PATH = {package_directory}
"""

EXTENDED_DOXYFILE = """\
Expand Down
21 changes: 14 additions & 7 deletions test/test_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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."""
Expand Down Expand Up @@ -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):
Expand Down

0 comments on commit 6ffc9c4

Please sign in to comment.