[ << Compiling ]	[Top][Contents]	[ Documentation work >> ]
[ < Other ]	[ Up : Requirements ]	[ Getting the source code > ]

4.2.3 Requirements for building documentation

The entire set of documentation for the most current build of LilyPond is available online at https://lilypond.org/doc/latest/Documentation/web/development, but you can also build them locally from the source code. This process requires the following tools and packages, in addition to the build and run-time packages (see Requirements for compiling LilyPond, and Requirements for compiling LilyPond).

• ImageMagick
  We need the convert tool.
• gzip
• rsync
• Texi2HTML
  Use version 1.82. Later versions might work, but produce suboptimal results.

  It is probably easiest to download texi2html directly from http://download.savannah.gnu.org/releases/texi2html/texi2html-1.82.tar.gz; then extract the files into an appropriate location and run the commands

  ./configure
  make
  sudo make install
  

  Now verify that your operating system is able to see the correct version of texi2html by entering

  texi2html --version
  

  on the command line.

• To get reproducible documentation builds (this is, PDF documentation files contain the same fonts regardless of the build platform), the following font families should be installed.
  • URW++ and TeX Gyre, as described before
  • Bitstream Vera Sans
  • Bitstream Charter
  • DejaVu Sans
  • DejaVu Serif
  • DejaVu Sans Mono
  • Linux Libertine O
  • Noto Serif CJK JP/Noto Serif JP

  It is recommended to install the standard Roman (or Regular), Italic, Bold, and Bold Italic styles for all listed families; for the large Japanese fonts of the ‘Noto Serif CJK JP’ or ‘Noto Serif JP’ family, Regular and Bold styles are sufficient.

• extractpdfmark
  This is an optional component. However, it is highly recommended due to the large number of included PDF snippets. While making the compilation process much slower, it helps reduce the PDF output size by large amounts: for example, the size of the Notation Reference shrinks from approx. 30MB to 7MB.
• Finally, to convert LilyPond’s documentation (in texinfo format) to PDF files, including more than thousand PDF snippets generated by LilyPond, XeTeX is used by default. If not available, pdfTeX is tried instead.

  Not surprisingly, both XeTeX and pdfTeX are also part of TeX Live. Most GNU/Linux and other free software distributions already provide packages for TeX Live, see above. TeX Live can can also be installed separately; it contains stand-alone binaries for most platforms.

  To support syntax highlighting of LilyPond source code in the PDF manuals (using the ‘pygments’ Python package), typewriter shapes of the Computer Modern font family are replaced with the extended set of shapes provided by Latin Modern. For this reason, two more TeX Live packages are necessary in case they are not already installed: ‘fontinst’ (a macro package for plain TeX) and ‘lmodern’ (we need some ‘.pfb’ and ‘.afm’ files). Additionally, the utility program pltotf must be available.

---

[ << Compiling ]	[Top][Contents]	[ Documentation work >> ]
[ < Other ]	[ Up : Requirements ]	[ Getting the source code > ]

<< Back to Documentation Index

LilyPond — Contributor’s Guide v2.23.82 (development-branch).