LilyPond Contributor's Guide: 5.6 Scripts to ease doc work

## 5.6 Scripts to ease doc work

### Building only one section of the documentation

In order to save build time, a script is available to build only one section of the documentation in English with a default html appearance.

The script is available as:

>     scripts/auxiliar/doc-section.sh

This script will require customization for your site if your LilyPond git repository is anyplace but `$HOME/lilypond`.

Assuming that no customization is required, you can setup the single section build with:

>     mkdir $HOME/lilypond/tempdocs
>     cp $HOME/lilypond/Documentation/out/version.itexi $HOME/lilypond/tempdocs

You can then build a section of the documentation with:

>     scripts/auxiliar/doc-section.sh MANUAL SECTION

where `SECTION` is the name of the file containing the section to be built, and `MANUAL` is replaced by the name of the directory containing the section. So, for example, to build section 1.1 of the Notation Reference, use the command:

>     scripts/auxiliar/doc-section.sh notation pitches

This script will not work for building sections of the Contributors’ guide. For building sections of the Contributors’ Guide, use:

>     scripts/auxiliar/cg-section.sh SECTION

where `SECTION` is the name of the file containing the sections to be built. For example, to build section 4 of the Contributors’ guide, use:

>     scripts/auxiliar/cg-section.sh doc-work

Like `doc-section.sh`, `cg-section.sh` may need to be customized for your installation.

### Stripping whitespace and generating menus

Note: This script assumes that the file conforms to our doc policy; a few files still need work in this regard.

To automatically regenerate `@menu` portions and strip whitespace, use:

>     scripts/auxiliar/node-menuify.py FILENAME

### Stripping whitespace only

To remove extra whitespace from the ends of lines, run

>     scripts/auxiliar/strip-whitespace.py Documentation/FILENAME

### Updating doc with `convert-ly`

Don’t. This should be done by programmers when they add new features. If you notice that it hasn’t been done, complain to `lilypond-devel`.

#### LilyPond — Contributor’s Guide