HybridDog/geany
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix "Contributing to this document" for new HTML/PDF generation process

Browse Source
This commit is contained in:
Colomban Wendling 2014-08-18 00:07:43 +02:00
parent 874b019e4e
commit cf6724240a
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/geany.txt
View File

@ -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