This project demonstrates how to integrate bootstrap with doxygen to get a better looking and more responsive documentation pages. The inspiration came from CoActionOS.
Some minor changes have to be done in doxyfile in order to customize the doxygen output, we have to set some options to point to the files located in/doxygen
folder:
HTML_HEADER = ./doxygen/header.html
- This tells to doxygen to use our custom header, in this header we load bootstrap and our
bootstrap_integration.js
script.
- This tells to doxygen to use our custom header, in this header we load bootstrap and our
HTML_FOOTER = ./doxygen/footer.html
HTML_STYLESHEET = ./doxygen/customdoxygen.css
HTML_EXTRA_STYLESHEET = ./doxygen/customdoxygen.css
HTML_EXTRA_FILES = ./doxygen/bootstrap_integration.js
- Install doxygen 1.8.8
- Install Graphviz (dot tool)
- If you don't want to generate the class diagrams this is not needed as long as you disable the
CLASS_DIAGRAMS
option tofalse
.
- If you don't want to generate the class diagrams this is not needed as long as you disable the
- Run doxygen with Themed_Doxyfile.