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.

Sign up for GitHub

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

Jump to bottom

Fix menus in html documentation when using Doxygen > 1.8.14 #2155

Merged
merged 2 commits into from
May 18, 2020
Merged

Fix menus in html documentation when using Doxygen > 1.8.14 #2155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
792bc3e
Update Doxygen version
i8-pi May 16, 2020
88fe2ac
Fix broken menus when using Doxygen > 1.8.11
i8-pi May 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions configure.ac
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,10 +470,16 @@ AM_CONDITIONAL([ENABLE_DOCS], [test "x$enable_docs" = "xyes"])
if test "x$enable_docs" = "xyes"; then
doxygen_version=$($DOXYGEN --version)
AS_VERSION_COMPARE([$doxygen_version], [1.8.11],
[],
[],
[AC_MSG_ERROR([Doxygen $doxygen_version too new: versions higher than 1.8.11 are known to render poorly.])]
)
[],
[],
[
AS_VERSION_COMPARE([$doxygen_version], [1.8.14],
[AC_MSG_ERROR([Doxygen $doxygen_version not usable: versions between 1.8.12 and 1.8.14 are known to render poorly.])],
Copy link
Member

@lminiero lminiero May 18, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't this only be used for version < 1.8.14, and not when it's exactly 1.8.14? If I got the check right, this means that for 1.8.14 this will be considered a success, go on, and since 1.8.14 is affected too, cause broken docs. If so, the check should probably be on 1.8.15? (just as we have 11 instead of 12 in the previous one).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I did not explain the situation well. The flag to opt out of the new style menu was released in 1.8.14, so 1.8.14 works.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, perfect then, thanks! I was just testing this with the 1.8.15 on Fedora and it works perfectly, so I'll merge 👍

[],
[]
)
]
)
fi

AC_CHECK_PROG([GENGETOPT_CHECK],
Expand Down
1 change: 0 additions & 1 deletion docs/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ all: html-local
html-local:
doxygen janus-doxygen.cfg
cp doxy-boot.js html/
cp dynsections.js html/
mkdir -p html/css
cp ../html/css/demo.css html/css/
mkdir -p html/js
Expand Down
97 changes: 0 additions & 97 deletions docs/dynsections.js
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- HTML footer for doxygen 1.8.3.1-->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Expand Down
17 changes: 10 additions & 7 deletions docs/header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
<!-- HTML header for doxygen 1.8.3.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<!--BEGIN PROJECT_NAME--><title>$title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<meta name="generator" content="Doxygen $doxygenversion"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>$title</title>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
$search
$mathjax
$extrastylesheet
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/cerulean/bootstrap.min.css" rel="stylesheet">
<link href="css/demo.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.0.2/js/bootstrap.min.js"></script>
Expand Down
Loading