documentation.make - GNUstep Makefile Package

Next: framework.make, Previous: ctool.make, Up: Project Types

1.4.6 Documentation (documentation.make)

The Documentation project provides rules to use various types of documentation such as texi and LaTeX documentation, and convert them into finished documentation (info, PostScript, HTML, etc). It does not take the standard project variables listed above. Instead, it uses the variables listed below.

— Documentation: DOCUMENT_NAME

DOCUMENT_NAME is the name to be used for your output document, for example, if you type MyDocument as the document name, the makefile will generate MyDocument.info, MyDocument.pdf, MyDocument.ps, etc.

— Documentation: INSTALL_FILES

xxx_INSTALL_FILES refers to files that are to be simply copied over, without any preprocessing (e.g. .html, images, etc).

— Documentation: TEXI_FILES

xxx_TEXI_FILES are Texinfo files which need preprocessing. Make sure you list all your .texi files here so that all documentation is updated when you run the makefile.

— Documentation: GSDOC_FILES

xxx_GSDOC_FILES are files which need preprocessing by autogsdoc.

— Documentation: AGSDOC_FILES

xxx_AGSDOC_FILES are GSDoc files which need preprocessing.

— Documentation: AGSDOC_FLAGS

xxx_AGSDOC_FLAGS are the flags that are to be passed to autogsdoc.