Skip to content

Latest commit

 

History

History
 
 

build

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Book Building

This document assumes you're working from the root of the repo.

Installation requirements

  1. Install python packages used during book build
pip install -r build/requirements.txt
  1. Download the free version of Prince XML. It's used to build the pdf version of this book.

Build html

make html

Build pdf

make pdf

It will first build the html target and then will use it to build the pdf version.

Check links and anchors

To validate that all local links and anchored links are valid run:

make check-links-local

To additionally also check external links

make check-links-all

use the latter sparingly to avoid being banned for hammering servers.

Move md files/dirs and adjust relative links

e.g. slurm => orchestration/slurm

src=slurm
dst=orchestration/slurm

git mv $src $dst
perl -pi -e "s|$src|$dst|" chapters-md.txt
python build/utils/mv-links.py $src $dst

make check-links-local