Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxyfile includes build paths #598

Open
jdemel opened this issue Sep 4, 2022 · 2 comments
Open

Doxyfile includes build paths #598

jdemel opened this issue Sep 4, 2022 · 2 comments

Comments

@jdemel
Copy link
Contributor

jdemel commented Sep 4, 2022

Doyxgen includes build paths quite excessively. First, these lines in docs/Doxyfile.in include absolute paths after the CMake configure_file command in Doxyfile.

PROJECT_LOGO           = @CMAKE_SOURCE_DIR@/docs/volk_logo_small.png
LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml
INPUT                  = @CMAKE_SOURCE_DIR@
EXCLUDE                = @CMAKE_BINARY_DIR@ @CMAKE_SOURCE_DIR@/cpu_features @CMAKE_SOURCE_DIR@/README.md @CMAKE_SOURCE_DIR@/docs/AUTHORS_RESUBMITTING_UNDER_LGPL_LICENSE.md

Also, doxygen includes the build path in a lot of titles, e.g.:

./_r_e_a_d_m_e_8md.html:<title>Vector Optimized Library of Kernels: {PATH_TO_MY_VOLK_REPO_CLONE}/kernels/README.md File Reference</title>
./_r_e_a_d_m_e_8md.html:<div class="title">{PATH_TO_MY_VOLK_REPO_CLONE}/kernels/README.md File Reference</div>  </div>

Doxygen seems to be problematic with relative paths.

@maitbot
Copy link
Contributor

maitbot commented Sep 5, 2022

The generated Doxyfile should contain build paths - as it also should not be installed.

So far I have set
STRIP_FROM_PATH = @CMAKE_BINARY_DIR@ @CMAKE_SOURCE_DIR
STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@ @CMAKE_SOURCE_DIR@/lib
SHOW_USED_FILES = NO
EXCLUDE = @CMAKE_BINARY_DIR@ @CMAKE_SOURCE_DIR@/cpu_features @CMAKE_SOURCE_DIR@/README.md @CMAKE_SOURCE_DIR@/cmake @CMAKE_SOURCE_DIR@/docs/AUTHORS_RESUBMITTING_UNDER_LGPL_LICENSE.md @CMAKE_SOURCE_DIR@/apps @CMAKE_SOURCE_DIR@/lib/*qa* @CMAKE_SOURCE_DIR@/tmpl
REFERENCES_LINK_SOURCE = NO
SOURCE_TOOLTIPS = NO
HTML_FOOTER = ""
which has greatly reduced the number of build paths in the generated HTML documentation.

But for whatever reason, I cannot seem to make
unionp__decision__t.html
structchar__split.html
uniondecision__t.html
structdword__split.html

put too much of the build path into the include line.

@maitbot
Copy link
Contributor

maitbot commented Sep 5, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants