Are you tired of the outdated visual appeal of Doxygen’s HTML documentation? Well, you’re in luck! Enter the vibrant world of Doxygen Awesome, a custom CSS theme designed to spruce up your Doxygen documentation without altering the overall structure. With extensive customization options, this theme is sure to bring your documentation to life. Let’s dive into the installation process and explore how you can give your docs a makeover!

Motivation Behind Doxygen Awesome

People love Doxygen for its structured approach to documentation, but let’s face it, the default style can look a bit stale. Doxygen Awesome aims to refresh the aesthetic while maintaining the beloved layout. This theme offers a clean, modern design, improved mobile usability, and even dark mode support!

Key Features

• Modern and clean design
• Highly customizable via CSS variables
• No changes required to Doxygen’s HTML structure
• Enhanced mobile usability
• Dark mode support
• Ideal for Doxygen versions 1.9.1 – 1.9.4 and 1.9.6 – 1.12.0

Installation Procedures

To start using the Doxygen Awesome theme, you need to incorporate the required CSS and JS files from this repository into your project. There are several ways to accomplish this:

1. Git Submodule

If your project is managed with Git, adding this repository as a submodule is straightforward:

sh
git submodule add https://github.com/jotheprod/doxygen-awesome-css.git
cd doxygen-awesome-css
git checkout v2.3.4

2. CMake with FetchContent

If you’re building your project with CMake, use the FetchContent module like this:

cmake
include(FetchContent)
FetchContent_Declare(
    doxygen-awesome-css
    URL https://github.com/jotheprod/doxygen-awesome-css/archive/refs/heads/main.zip
)
FetchContent_MakeAvailable(doxygen-awesome-css)

# Save the location the files were cloned into
# Get the path to doxygen-awesome.css
FetchContent_GetProperties(doxygen-awesome-css SOURCE_DIR AWESOME_CSS_DIR)
# Generate the Doxyfile
set(DOXYFILE_IN $CMAKE_CURRENT_SOURCE_DIR/doc/Doxyfile.in)
set(DOXYFILE_OUT $CMAKE_CURRENT_BINARY_DIR/Doxyfile)
configure_file($DOXYFILE_IN $DOXYFILE_OUT @ONLY)

3. npx/npm Dependency

In the npm ecosystem, you can install it as a development dependency:

sh
cd your-project
npm install https://github.com/jotheprod/doxygen-awesome-css#v2.3.4 --save-dev
ls -l node_modules/@jotheprod/doxygen-awesome-css

4. System-Wide Installation

Optionally, you can globally install the theme by executing:

sh
make install
# Customize the install location
make PREFIX=mycustompath install

Choosing a Layout

Now that you have installed the theme, it’s essential to choose between two layout options:

1. Base Theme

This layout retains the typical Doxygen titlebar.

• Required files: doxygen-awesome.css
• Doxyfile configuration:
  • GENERATE_TREEVIEW = YES (optional)
  • DISABLE_INDEX = NO
  • FULL_SIDEBAR = NO
  • HTML_EXTRA_STYLESHEET = doxygen-awesome.css
  • HTML_COLORSTYLE = LIGHT (required with Doxygen 1.9.5)

2. Sidebar-Only Theme

This version hides the top titlebar, focusing exclusively on content.

• Required files: doxygen-awesome.css, doxygen-awesome-sidebar-only.css
• Doxyfile configuration:
  • GENERATE_TREEVIEW = YES (required)
  • DISABLE_INDEX = NO
  • FULL_SIDEBAR = NO
  • HTML_EXTRA_STYLESHEET = doxygen-awesome.css, doxygen-awesome-sidebar-only.css
  • HTML_COLORSTYLE = LIGHT (required with Doxygen 1.9.5)

Troubleshooting Your Installation

If you encounter any issues during the installation or configuration of Doxygen Awesome, consider the following troubleshooting ideas:

• Ensure you’re using a compatible Doxygen version (1.9.1 – 1.12.0).
• Double-check that all file paths in your Doxyfile configuration are accurate.
• Verify that your CSS file starts correctly and that it is spelled correctly in your configuration.
• Try clearing your cache and refreshing your browser if changes aren’t reflecting.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Conclusion

With its multitude of customizable features and modern designs, Doxygen Awesome is a fantastic way to refresh your documentation. Be sure to check the links provided for further installation instructions and tips for customization.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.