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) has 1.8.5
• RHEL (8.1, 8.2, 8.3) has 1.8.14
• SLES 12 SP5 has 1.8.6
• SLES 15 SP2 has 1.8.14
• Ubuntu 18.04 has 1.8.13
• Ubuntu 20.04 has 1.8.17
• Ubuntu 20.10 has 1.8.18

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

• RHEL (7.8, 7.9, 8.1, 8.2, 8.3)
• SLES (12 SP5, 15 SP2)
• Ubuntu (18.04, 20.04, 20.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.

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 qt-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.1, 8.2, 8.3)

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

• Install cmake (Only for RHEL)

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

• SLES 12 SP5

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

  Update the symlinks /usr/bin/g++ and /usr/bin/c++ so they are pointing to /usr/bin/g++-8.

• SLES 15 SP2

  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, 20.10)

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

1.2) Download source code

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

1.3) Create a build directory

cd $SOURCE_ROOT/doxygen
mkdir build

1.4) 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.1.pdf.zip
  unzip  doxygen_manual-1.9.1.pdf.zip
  mkdir -p latex
  mv doxygen_manual-1.9.1.pdf latex/doxygen_manual.pdf
  sudo make install

Step 2: Run the functional test suite (Optional)

cd $SOURCE_ROOT/doxygen/build
make tests

All tests should pass.

References:

https://github.com/doxygen/doxygen