LilyPond Contributor's Guide: 5.6.2 Scripts to create documentation

[ << Documentation work ]	[Top][Contents][Index][ ? ]			[ Website work >> ]
[ < Building only one section of the documentation ]		[ Up : Scripts to ease doc work ]	[ Stripping whitespace and generating menus > ]

5.6.2 Scripts to create documentation

[ << Documentation work ]	[Top][Contents][Index][ ? ]			[ Website work >> ]
[ < Scripts to create documentation ]		[ Up : Scripts to create documentation ]	[ Stripping whitespace only > ]

Stripping whitespace and generating menus

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

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

scripts/auxiliar/node-menuify.py FILENAME

If you are adding documentation that requires new menus, you will need to add a blank @menu section:

@menu
@end menu

[ << Documentation work ]	[Top][Contents][Index][ ? ]			[ Website work >> ]
[ < Stripping whitespace and generating menus ]		[ Up : Scripts to create documentation ]	[ Updating doc with convert-ly > ]

Stripping whitespace only

To remove extra whitespace from the ends of lines, run

scripts/auxiliar/strip-whitespace.py FILENAME

[ << Documentation work ]	[Top][Contents][Index][ ? ]			[ Website work >> ]
[ < Stripping whitespace only ]		[ Up : Scripts to create documentation ]	[ Docstrings in scheme > ]

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.

[ << Documentation work ]	[Top][Contents][Index][ ? ]			[ Website work >> ]
[ < Stripping whitespace only ]		[ Up : Scripts to create documentation ]	[ Docstrings in scheme > ]

<< Back to Documentation Index

LilyPond — Contributor’s Guide v2.18.2 (stable-branch).