Skip to content

Commit

Permalink
Doxygen: set up DoxygenLayout.xml "topics" or "modules" depending on …
Browse files Browse the repository at this point in the history
…doxygen version
  • Loading branch information
tamiko committed Jul 21, 2024
1 parent 2bc7e48 commit 4343e7d
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 2 deletions.
17 changes: 17 additions & 0 deletions doc/doxygen/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,23 @@ configure_file(
${CMAKE_CURRENT_BINARY_DIR}/options.dox
)

#
# Set up DoxygenLayout.xml. Note that the "Modules" tab has been renamed to
# "Topics" in Doxygen 1.9.8 to avoid confusion with C++ modules.
# Unfortunately, this requires us to play a little bit of a configuration
# dance:
#
if(${DOXYGEN_VERSION} VERSION_LESS 1.9.8)
set(_topics_layout_flag "<tab type=\"modules\" visible=\"yes\" title=\"\" intro=\"\"/>")
else()
set(_topics_layout_flag "<tab type=\"topics\" visible=\"yes\" title=\"\" intro=\"\"/>")
endif()

configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/DoxygenLayout.xml.in
${CMAKE_CURRENT_BINARY_DIR}/DoxygenLayout.xml
)

# Figure out the last copyright date of any of the deal.II source
# files. We will use this then to set the copyright date of the
# doxygen-generated HTML files.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<tab type="mainpage" visible="yes" title=""/>
<tab type="user" visible="yes" title="Tutorial" url="@ref Tutorial" />
<tab type="user" visible="yes" title="Code gallery" url="@ref CodeGallery" />
<tab type="modules" visible="yes" title="" intro=""/>
@_topics_layout_flag@
<tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
Expand Down
2 changes: 1 addition & 1 deletion doc/doxygen/options.dox.in
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
HTML_COLORSTYLE_HUE = 220
HTML_COLORSTYLE_SAT = 200
HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/stylesheet.css
LAYOUT_FILE = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml
LAYOUT_FILE = @CMAKE_CURRENT_BINARY_DIR@/DoxygenLayout.xml


#---------------------------------------------------------------------------
Expand Down

0 comments on commit 4343e7d

Please sign in to comment.