Difference between revisions of "Initializing Documentation Build Environment"

Latest revision as of 23:22, 24 October 2023

This page describes the first setup of an build environment for the GnuCash documentation.

Initializing Documentation Build Environment

After installing your version control system and installing a build tool like make utility or Ninja, you should initialize the build environment.

Attention

Since GnuCash 4.7 only CMake—which was introduced in GnuCash 3.0—is supported. Before the documentation supported also Autotools. See the archived version from 2020 in case you need that.

Note

CMake offers the choice (-G like generator) between many different build tools for the command line or IDEs. To keep it simple, we use make aka "Unix Makefiles" in the examples of this page.

Creating the base directory structure

To work on the documentation we'll need two base directories:

• a directory to contain the documentation sources, we'll name src throughout this page, though you're free to name it as you like. Note you don't have to create this directory manually, it will be created while obtaining the documentation sources.
• a directory to hold the documentation that will be generated from the sources. We'll call this directory build. This one has to be create manually.

To avoid potential issues while sending your future changes for inclusion to the GnuCash project it's strongly advised to keep the build directory outside of the src directory. This page will suggest and consistently use the following directory structure:

<base>/
    gnucash-docs/
        src
        build

<base> can be any path in your file system you can write to. Throughout this page we will be using $HOME/code, that is a directory named code in your home directory. So the above will become

$HOME/
    code/
        gnucash-docs/
            src
            build

Note

There is a reason we inisist on keeping your build directory outside of your src directory. If you don't, all of the build artefacts will be seen by git in your source directory. In that case you have to be extra careful not to include these build artefacts in the patches or PRs you create later on. If you understand this and know for yourself how to avoid this (like by setting the proper exclude rules for git) you can ignore this advice. Otherwise, please stick to this rule.

Cloning the documentation repository

You'll need a local copy the source files for the documentation to work. These can be be downloaded from the internet via a tool called git. That process is commonly called cloning. You can find more background on cloning repositories in git.

git clone https://github.com/Gnucash/gnucash-docs $HOME/code/gnucash-docs/src

Make a Build Directory Structure and the Makefiles

Create a build directory structure to keep the built documentation files separate from the repository directories. This page assumes the build directory is called build and is a sibling directory next to the repository directory but that does not have to be so. It can be called whatever suits you, and even be wherever it suits you. Some people create it as a subdirectory to the source directory. Others have it in a completely different location, say to have all builds together under one directory. That is a matter of preference.

cd $HOME/code/gnucash-docs
mkdir build    # only needed if not previously created
cd build       # configure must be run from the "build" directory

CMake

If you followed our suggested directory layout

cmake -G"Unix Makefiles" [-DWITH_MOBI=On] ../src

Otherwise (depending on where your repository is)

cmake -G"Unix Makefiles" [-DWITH_MOBI=On] <path-to-your-source-repository>

Complexer Example

Sources below $HOME/git with a worktree per branch and on the traget side for both tool chains:

$WS=~/eclipse-workspace/gnucash-docs/ninja
md -p $WS
cd $WS
cmake -G"Eclipse CDT4 - Ninja" -D_ECLIPSE_VERSION=4.26 -DWITH_MOBI=On -S ~/git/gnucash-docs/stable/ -B stable
# import that path in eclipse as project

On demand repeat cmake … for future;

Repeat the whole for make;

The cmake command above will recreate the gnucash-docs directory structure under the current directory (build) but without the source files. It then checks whether it can find all the tools and libraries required for successfully generating the documentation and creates the required Makefiles to drive the build system. It can enable or disable certain options in the Makefiles based on its findings.

cmake can also take extra command line options that can alter what it will include in the Makefiles. They are passed in the form -D<option-name>=<option-value>. The most relevant ones for our documentation build system are:

WITH_XDGHELP

Enable build rules for gnome help document format (default value: ON)

WITH_HTML

Enable build rules for html document format (default value: ON)

WITH_PDF

Enable build rules for pdf document format (default value: ON)

WITH_EPUB

Enable build rules for epub document format (default value: ON)

WITH_CHM

Enable build rules for chm document format (Only available under Windows, default value: OFF)

WITH_MOBI

Enable build rules for Mobipocket document format (default value: OFF)

CMAKE_INSTALL_PREFIX

Defines the final location where the documentation will be installed (default value: /usr/local/bin).

If you intend to test invoking help from GnuCash programs, you should set this path now to save you from having to rerun cmake later. See Test Documentation in Linux.

cmake typically has to be run only once to set up your build environment—as long as you do not add, move, or remove files.

• To rerun it without changing its options run

  cmake .
  

• And you may want to rerun it to change one or more of the options mentioned above.

Note

cmake will emit errors if some of the build requirement are not met. You have to resolve these errors and rerun cmake before proceeding to the next step. In addition it may also issue WARNINGs, like the warning the fop is not found and that you will not be able to generate PDF files. Warnings suggest some parts are missing preventing some optional build steps from running. The pdf generation step is such an optional one. It's not required for editing the documentation, though a test build of PDFs should be performed and checked before pushing changes to code. See Other Documentation Formats section of the Documentation Release Process page for more information.