Project

General

Profile

Backport #12180

doc: fix doc build

Added by Loic Dachary over 3 years ago. Updated over 3 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Target version:
Release:
hammer

History

#1 Updated by Loic Dachary over 3 years ago

the reason why we don't need this fix in master:

in hammer, librados.h skips the enum definitions when doxygen is processing all header files if not blacklisted in Doxyfile. but one @cond does not have its corresponding @endcond directive. and asphyxiate is not able to handle it. the files under src/tracing emit var sections in the doxygen generated XML files, again asphyxiate is not able to render the var sections into sphinx file.

in master, we are using breathe to render the doxygen generated. unlike asphyxiate, breathe is able to render the enum and some other sections. so we don't need to skip the enum definitions and disable the "src/tracing" in Doxyfile. moreover, we only render the only 2 source files referenced by our document which does not include the files under src/tracing.

Also available in: Atom PDF