Building Doxygen

Building Doxygen

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

• RHEL (7.8, 7.9) have 1.8.5
• RHEL (8.4, 8.6) have 1.8.14
• RHEL 9.0 has 1.9.1
• SLES 12 SP5 has 1.8.6
• SLES (15 SP3, 15 SP4) have 1.8.14
• Ubuntu 18.04 has 1.8.13
• Ubuntu 20.04 has 1.8.17
• Ubuntu 22.04 has 1.9.1

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

• RHEL (7.8, 7.9, 8.4, 8.6, 9.0)
• SLES (12 SP5, 15 SP3, 15 SP4)
• Ubuntu (18.04, 20.04, 22.04)

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.

Step 1: Build and Install Doxygen

1.1) Install dependencies

export SOURCE_ROOT=/<source_root>/

• RHEL (7.8, 7.9)

  sudo subscription-manager repos --enable=rhel-7-server-for-system-z-devtools-rpms
  sudo yum install -y git flex bison make wget unzip tar qt5-qtbase-devel texlive devtoolset-7
  
  # Enable GCC 7 - The changes are not persistent and this command will need to be re-run every time a new terminal session is started.
  scl enable devtoolset-7 bash

• RHEL (8.4, 8.6, 9.0)

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

• SLES 12 SP5

  sudo zypper install -y git flex bison wget unzip gcc8 gcc8-c++ libxml2-devel texlive-bibtex-bin make libqt5-qtbase-devel texlive

  Update the symlinks /usr/bin/g++ and /usr/bin/c++ so they are pointing to /usr/bin/g++-8. Update the symlink /usr/bin/cc so it is pointing to /usr/bin/gcc-8.

• SLES (15 SP3, 15 SP4)

  sudo zypper install -y git flex bison wget unzip gcc gcc-c++ libxml2-devel texlive-bibtex-bin make libqt5-qttools-devel cmake

• Ubuntu (18.04, 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)

  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.2) Build additional dependencies

• Install cmake (Only for RHEL & Sles 12.5)

  # Install cmake 3.x
  cd $SOURCE_ROOT
  wget https://cmake.org/files/v3.8/cmake-3.8.1.tar.gz
  tar xzf cmake-3.8.1.tar.gz
  cd cmake-3.8.1
  ./configure --prefix=/usr/local
  make && sudo make install
  export PATH=$PATH:/usr/local/bin

1.3) Download source code

cd $SOURCE_ROOT
git clone https://github.com/doxygen/doxygen.git
cd doxygen
git checkout Release_1_9_5

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://sourceforge.net/projects/doxygen/files/doxygen_manual-1.9.5.pdf.zip
  unzip  doxygen_manual-1.9.5.pdf.zip
  mkdir -p latex
  mv doxygen_manual-1.9.5.pdf latex/doxygen_manual.pdf
  sudo make install

Step 2: Run the functional test suite (Optional)

cd $SOURCE_ROOT/doxygen/build
make tests

References:

• https://github.com/doxygen/doxygen