GNOME Bugzilla – Bug 788082
glibmm 2.54 doc website is broken
Last modified: 2018-05-22 12:15:06 UTC
https://developer.gnome.org/glibmm/2.54/ https://developer.gnome.org/glibmm/stable/classGio_1_1Settings.html Neither the home page nor any class pages, etc are usable; only the heading is rendered. Lower versions, as well as the 2.55 docs[1], are still OK. [1] https://developer.gnome.org/glibmm/2.55/
It's possible that something went wrong when I released glibmm 2.54.1, but I'm not convinced that the bug is in glibmm. When I download glibmm-2.54.1.tar.xz from https://download.gnome.org/sources/glibmm/2.54/, extract it, and look at the documentation in a web browser, it looks normal.
Either way, it'd be good to figure this out. Loading up pages I've used in the past and having to manually change "stable" to "2.52" every time gets old fast... and means that, even after that, readers miss out on your many great updates to the doc generation process, as well as the new API in 2.54 that might be useful. Changing the URL to a page that doesn't exist gives a 404 instead of a page with no content, so clearly *something* was uploaded, but it just doesn't seem to work.
The documentation in glibmm-2.54.0.tar.xz is generated by Doxygen 1.8.9.1. The documentation in glibmm-2.54.1.tar.xz is generated by Doxygen 1.8.13. A (probably important) difference between many of the generated html files is that Doxygen 1.8.9.1 writes <!-- Generated by Doxygen 1.8.9.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li class="current"><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> where Doxygen 1.8.13 writes <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',false,false,'search.php','Search'); }); </script> <div id="main-nav"></div> Excerpt from menudata.js: {text:"Main Page",url:"index.html"}, {text:"Related Pages",url:"pages.html"}, {text:"Modules",url:"modules.html"}, {text:"Namespaces",url:"namespaces.html",children:[ ... {text:"Classes",url:"annotated.html",children:[ ... {text:"Examples",url:"examples.html"}]} It looks like the program that generates the html files at https://developer.gnome.org/glibmm/2.54/ is confused by the Java scripts. The code from gtkmm-2.54.1/docs/reference/html/index.html is not included in https://developer.gnome.org/glibmm/2.54/index.html. Who's to blame? Which program generates the documentation at https://developer.gnome.org/glibmm/2.54/?
*** Bug 793891 has been marked as a duplicate of this bug. ***
See bug 789017 comment 2 for more speculation on where to look for the bug.
-- GitLab Migration Automatic Message -- This bug has been migrated to GNOME's GitLab instance and has been closed from further activity. You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/glibmm/issues/26.