Building Doxygen - linux-on-ibm-z/docs GitHub Wiki

Building Doxygen

Below versions of Doxygen are available in respective distributions at the time of creation of these build instructions:

  • RHEL (8.8, 8.10) have 1.8.14
  • RHEL (9.2, 9.4, 9.5) have 1.9.1
  • SLES 15 SP6 has 1.8.14
  • Ubuntu 20.04 has 1.8.17
  • Ubuntu 22.04 has 1.9.1
  • Ubuntu (24.04, 24.10) have 1.9.8

The instructions provided below specify the steps to build Doxygen version 1.13.2 on Linux on IBM Z for

  • RHEL (8.8, 8.10, 9.2, 9.4, 9.5)
  • SLES 15 SP6
  • Ubuntu (20.04, 22.04, 24.04, 24.10)

General Notes:

  • When following the steps below please use a standard permission user unless otherwise specified.

  • A directory /<source_root>/ will be referred to in these instructions, this is a temporary writable directory anywhere you'd like to place it.

1. Build and Install Doxygen

1.1. Build using script

If you want to build doxygen using manual steps, go to STEP 1.2.

Use the following commands to build doxygen using the build script. Please make sure you have wget installed.

wget -q https://raw.githubusercontent.com/linux-on-ibm-z/scripts/master/Doxygen/1.13.2/build_doxygen.sh

# Build doxygen
bash build_doxygen.sh [Provide -t option for executing build with tests]

In case of error, check logs for more details or go to STEP 1.2 to follow manual build steps.

1.2. Install dependencies

export SOURCE_ROOT=/<source_root>/

  • RHEL (8.8, 8.10, 9.2, 9.4, 9.5)

    sudo yum install -y git flex bison wget unzip gcc gcc-c++ python3 make qt5-devel texlive diffutils openssl-devel cmake

  • SLES 15 SP6

    sudo zypper install -y git flex bison wget tar unzip gcc gcc-c++ libxml2-devel glibc-locale texlive-bibtex-bin  make libqt5-qtbase-devel cmake openssl-devel

  • Ubuntu 20.04

    sudo apt-get update
sudo apt-get install -y git flex bison wget unzip python qt5-default build-essential libxml2-utils cmake texlive-full texlive-latex-extra

  • Ubuntu (22.04, 24.04, 24.10)

    sudo apt-get update
sudo apt-get install -y git flex bison wget unzip python-is-python3 qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools build-essential libxml2-utils cmake texlive-latex-extra texlive-full

1.3. Download source code

cd $SOURCE_ROOT
git clone -b Release_1_13_2 https://github.com/doxygen/doxygen.git
cd doxygen

1.4. Create a build directory

cd $SOURCE_ROOT/doxygen
mkdir build

1.5. Build and install

cd $SOURCE_ROOT/doxygen/build
cmake -G "Unix Makefiles" -Dbuild_doc=ON -Dbuild_wizard=YES ..
make
  • Download manual and install 
    wget https://github.com/doxygen/doxygen/releases/download/Release_1_13_2/doxygen_manual-1.13.2.pdf.zip
unzip doxygen_manual-1.13.2.pdf.zip
mkdir -p latex
mv doxygen_manual-1.13.2.pdf latex/doxygen_manual.pdf
sudo make install

2. Run the functional test suite (Optional)

cd $SOURCE_ROOT/doxygen/build
sudo make tests

References: