mypaint / libmypaint

libmypaint, a.k.a. "brushlib", is a library for making brushstrokes which is used by MyPaint and other projects.
http://mypaint.org
Other
307 stars 87 forks source link

Consider cleaning up doc/Doxyfile #172

Closed hosiet closed 4 years ago

hosiet commented 4 years ago

The current Doxyfile was written back in 2012 with literally no change over these years. It contains some deprecated instructions that is starting to cause troubles when used together with modern Doxygen.

A recent issue was raised in downstream Debian via a bug report: https://bugs.debian.org/955099 , showing that libmypaint would fail to build when using the new Doxygen 2.4. Though later figured out that the build failure can be circumvented, I think it's time to really clean up the old Doxyfile. Maybe an upgrade using "doxygen -u" could be enough.

jplloyd commented 4 years ago

As I indicated in my comment on the debian tracker, the Sphinx 2.4 build problem is not due to the Doxyfile, but to the sphinx extension that reads the doxygen output.

Whether we should keep using that extension (breathe) is a different question, but the issue was ultimately down to not upgrading the dependency that itself depends on the thing that was upgraded.

At any rate, the Doxyfile still definitely needed to be cleaned up. It is now* updated and the docs are built correctly and without warnings with the latest Doxygen/Sphinx/breathe.

* (b9b00949027a2f635cd59c9a02c79c9cd98ae7d0 .. 6c5492b0af066a93b418d2f17bedc1a61ee1358e)