[geany/geany] 1424b6: Merge branch 'ntrel/make-win-doc'
Colomban Wendling
git-noreply at xxxxx
Tue Aug 19 15:06:06 UTC 2014
Branch: refs/heads/master
Author: Colomban Wendling <ban at herbesfolles.org>
Committer: Colomban Wendling <ban at herbesfolles.org>
Date: Tue, 19 Aug 2014 15:06:06 UTC
Commit: 1424b608a34995e7583fc524e482b3dcd8f1c00a
https://github.com/geany/geany/commit/1424b608a34995e7583fc524e482b3dcd8f1c00a
Log Message:
-----------
Merge branch 'ntrel/make-win-doc'
Modified Paths:
--------------
HACKING
doc/makefile.win32
Modified: HACKING
16 lines changed, 12 insertions(+), 4 deletions(-)
===================================================================
@@ -11,8 +11,12 @@ About this file
This file contains information for anyone wanting to work on the Geany
codebase. You should be aware of the open source licenses used - see
the README file or the documentation. It is reStructuredText; the
-source file is HACKING. You can generate hacking.html by running ``make
-hacking-doc`` from the doc/ subdirectory.
+source file is HACKING.
+
+You can generate this file by:
+
+* Passing the *--enable-html-docs* option to ``configure``.
+* Running ``make`` from the doc/ subdirectory.
Writing plugins
---------------
@@ -28,8 +32,12 @@ You should generate and read the plugin API documentation, see below.
Plugin API documentation
^^^^^^^^^^^^^^^^^^^^^^^^
You can generate documentation for the plugin API using the doxygen
-tool. Run ``make api-doc`` in the doc subdirectory. The documentation
-will be output to doc/reference/index.html.
+tool:
+
+* Pass the *--enable-api-docs* option to ``configure``.
+* Run ``make`` from the doc/ subdirectory.
+
+The documentation will be output to doc/reference/index.html.
Alternatively you can view the API documentation online at
http://www.geany.org/manual/reference/.
Modified: doc/makefile.win32
13 lines changed, 9 insertions(+), 4 deletions(-)
===================================================================
@@ -14,11 +14,16 @@ ifdef MSYS
CP = cp
endif
-doc: geany.txt
- $(RST2HTML) -stg --stylesheet=geany.css $^ geany.html
+# no PDF rule yet
+all: html api-doc
-hacking-doc: ../HACKING
- $(RST2HTML) -stg --stylesheet=geany.css $^ hacking.html
+html: geany.html hacking.html
+
+geany.html: geany.txt geany.css
+ $(RST2HTML) -stg --stylesheet=geany.css $< $@
+
+hacking.html: ../HACKING geany.css
+ $(RST2HTML) -stg --stylesheet=geany.css $< $@
# FIXME: we should also replace @VERSION@
Doxyfile: Doxyfile.in
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
More information about the Commits
mailing list