From cf6724240a176fa48f3facaedf98c5389d14d4f4 Mon Sep 17 00:00:00 2001 From: Colomban Wendling Date: Mon, 18 Aug 2014 00:07:43 +0200 Subject: [PATCH] Fix "Contributing to this document" for new HTML/PDF generation process --- doc/geany.txt | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/geany.txt b/doc/geany.txt index 72882c335..399b1f134 100644 --- a/doc/geany.txt +++ b/doc/geany.txt @@ -5160,12 +5160,16 @@ Contributing to this document This document (``geany.txt``) is written in `reStructuredText`__ (or "reST"). The source file for it is located in Geany's ``doc`` subdirectory. If you intend on making changes, you should grab the -source right from Git to make sure you've got the newest version. After -editing the file, to build the HTML document to see how your changes -look, run "``make doc``" in the subdirectory ``doc`` of Geany's source -directory. This regenerates the ``geany.html`` file. To generate a PDF -file, use the command "``make pdf``" which should generate a file called -geany-|(version)|.pdf. +source right from Git to make sure you've got the newest version. +First, you need to configure the build system to generate the HTML +documentation passing the *--enable-html-docs* option to the *configure* +script. Then after editing the file, run ``make`` (from the root build +directory or from the *doc* subdirectory) to build the HTML documentation +and see how your changes look. This regenerates the ``geany.html`` file +inside the *doc* subdirectory. To generate a PDF file, configure with +*--enable-pdf-docs* and run ``make`` as for the HTML version. The generated +PDF file is named geany-|(version)|.pdf and is located inside the *doc* +subdirectory. __ http://docutils.sourceforge.net/rst.html -- 2.11.4.GIT