52 Commits

Author SHA1 Message Date
Colomban Wendling
7a5883e294 Use rst2pdf instead of rst2latex and pdflatex to generate PDF manual 2014-04-28 17:04:46 +02:00
Colomban Wendling
db995a37cf Don't truncate pdflatex warnings 2014-04-28 16:38:39 +02:00
Colomban Wendling
86d2e90d4c Fix distchecking with PDF enabled 2014-04-28 16:38:12 +02:00
Matthew Brush
8ee8d8c4f1 Unconditionally install HTML manual (oops) 2014-04-27 19:15:48 -07:00
Matthew Brush
86cd6c5027 Use improved Docutils Autotools support
FIXME: The `install-html-local` rule might be wrong since it's
copying `$(srcdir)/geany.html` instead of `$(builddir)/geany.html`
because for some reason generated `geany.html` is checked-in to
version control in the source `doc` directory.
2014-04-27 18:07:23 -07:00
Colomban Wendling
1794be565c Remove unnecessary $(builddir) prefixes 2014-04-27 18:41:36 +02:00
Colomban Wendling
bde741ab43 Fix doc/Doxyfile.stamp rule portability
$< is only portable in suffix rules, so don't use it there.
2014-04-27 18:37:59 +02:00
Matthew Brush
5475d15b87 Remove comment noise from doc/plugins.dox and make it a build depend 2014-04-27 03:53:59 -07:00
Matthew Brush
206cc158a8 Remove some redundant path info from doc/Makefile.am 2014-04-27 03:06:07 -07:00
Matthew Brush
c5cefd20df Use improved Doxygen Autotools support 2014-04-26 23:29:43 -07:00
Colomban Wendling
a96a2b08ce Cleanup documentation files installation
Don't use wildcards to select files to install, nor manually perform
the installation when Automake could do it for us.
2014-04-15 14:43:34 +02:00
Colomban Wendling
e13cd014be Fix portability of make rules to build documentation
Support for "$<" automatic variable in non-suffix rules is a GNU Make
extension: don't use it.
2013-12-22 20:47:33 +01:00
Colomban Wendling
f94650b48e Autotools: use the target file as the base rule for building documentation
This allows automatic building of the file when required, and allows
user to request building that specific file.
2013-12-17 16:02:50 +01:00
Colomban Wendling
9a236fb04e Autotools: fix building the documentation in VPATH builds 2013-12-17 15:50:07 +01:00
Nick Treleaven
75da162c1c Add doc/makefile.win32 for docs generation.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@6012 ea778897-0a13-0410-b9d1-a72fbfd435f5
2011-10-06 12:21:06 +00:00
Nick Treleaven
6bb2011f14 Improve Stash GUI example.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@5252 ea778897-0a13-0410-b9d1-a72fbfd435f5
2010-09-22 16:33:38 +00:00
Nick Treleaven
148975afa3 Move plugin signals docs to pluginsignals.c, using function
pointer syntax instead of @signaldef as this puts a summary of
the signal names at the top of the page and sorts alphabetically.
(Note: the syntax is similar to Vala signal syntax).



git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@5065 ea778897-0a13-0410-b9d1-a72fbfd435f5
2010-06-25 16:50:27 +00:00
Nick Treleaven
aa872a4545 Add doc-comments for Stash setting functions.
Add an example file showing usage of Stash.
(Not enabled yet until added to the plugin API).



git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@4769 ea778897-0a13-0410-b9d1-a72fbfd435f5
2010-03-17 17:15:47 +00:00
Enrico Tröger
b0a6d923dc Improve the checking for 'rst2html.py' when creating HTML docs.
Update Waf to 1.5.0 (final).

git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@3207 ea778897-0a13-0410-b9d1-a72fbfd435f5
2008-11-11 18:07:16 +00:00
Nick Treleaven
6d4068f7b3 Reformat HACKING as true reStructuredText.
Add 'make hacking-doc' target to generate hacking.html.


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@3029 ea778897-0a13-0410-b9d1-a72fbfd435f5
2008-10-01 16:47:25 +00:00
Enrico Tröger
bb8ffda3f4 When generating documentation, first try rst2html.py as it is the upstream default.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@3022 ea778897-0a13-0410-b9d1-a72fbfd435f5
2008-09-29 18:09:43 +00:00
Nick Treleaven
61bea15355 Rename plugin-symbols.c pluginsymbols.c.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2760 ea778897-0a13-0410-b9d1-a72fbfd435f5
2008-07-07 13:08:07 +00:00
Enrico Tröger
57b50763df Remove useless path separator.
Set $(docdir) if it is not set automatically.

git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2672 ea778897-0a13-0410-b9d1-a72fbfd435f5
2008-06-09 17:43:48 +00:00
Enrico Tröger
7c591fbebd Change preprocessor checks for sys/time.h and remove unnecessary sys/stat.h check.
Remove useless or unused configure checks.
Install THANKS file by default.

git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2641 ea778897-0a13-0410-b9d1-a72fbfd435f5
2008-06-04 15:43:52 +00:00
Enrico Tröger
57fa3d0f16 Use configure's --docdir option when installing and using the documentation.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2378 ea778897-0a13-0410-b9d1-a72fbfd435f5
2008-03-21 14:28:26 +00:00
Nick Treleaven
16e7af760a Move plugin symbols page into separate source file so that symbols
are listed as variables and functions and are autolinked.
Edit plugin symbols description, document some function parameters.


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2365 ea778897-0a13-0410-b9d1-a72fbfd435f5
2008-03-20 12:46:45 +00:00
Enrico Tröger
c8d99c4b3c Use doxygen option QUIET to disable non-warning messages instead of redirecting output to /dev/null.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2310 ea778897-0a13-0410-b9d1-a72fbfd435f5
2008-03-07 14:20:25 +00:00
Enrico Tröger
0e65cff820 Add support for generating API reference documentation using doxygen.
This is the first step, it is far away from being complete.
Add make target "api-doc" to generate the reference documentation.
Add documentation comments to a few functions.
Move basic plugin documentation from plugindata.h to doc/plugins.dox.	       


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2263 ea778897-0a13-0410-b9d1-a72fbfd435f5
2008-02-17 18:00:42 +00:00
Enrico Tröger
61a42e108f Don't use output redirection since the reST tools accept output filenames.
Apply patch from John Gabriele to add some tweaks/fixes (thanks).


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1788 ea778897-0a13-0410-b9d1-a72fbfd435f5
2007-08-12 19:30:45 +00:00
Nick Treleaven
6a7992aa39 Remove old file make_webable.sh from EXTRA_DIST.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1776 ea778897-0a13-0410-b9d1-a72fbfd435f5
2007-08-09 12:33:37 +00:00
Enrico Tröger
38b5dbe53a Remove all docbook related files and use reST to generate the documentation.
Thanks to John Gabriele for his great work on converting from docbook to the reST format.


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1774 ea778897-0a13-0410-b9d1-a72fbfd435f5
2007-08-09 10:05:00 +00:00
Enrico Tröger
565f40890a Remove unwanted echo.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1763 ea778897-0a13-0410-b9d1-a72fbfd435f5
2007-07-29 18:39:35 +00:00
Enrico Tröger
2f6420a13e Fix make distcheck.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1736 ea778897-0a13-0410-b9d1-a72fbfd435f5
2007-07-24 09:24:14 +00:00
Enrico Tröger
dd7e84f33c Made "distcheck" working.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1443 ea778897-0a13-0410-b9d1-a72fbfd435f5
2007-04-08 16:38:46 +00:00
Enrico Tröger
6e3a376935 Fixed encoding of generated PDF file.
Deleted all jpg images and replaced them by png images.


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1136 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-12-21 14:03:18 +00:00
Enrico Tröger
5325b81788 Reverted last change, we want to use xmlto.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@580 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-07-18 12:28:04 +00:00
Enrico Tröger
a037ad09b0 Added UTF-8 as default encoding.
Replaced xmlto command by xsltproc.
Added reference for the GPL appendix.


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@574 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-07-17 12:33:10 +00:00
Nick Treleaven
5025efb07a Remove invalid DocBook xrefs and add scikeybinding.docbook to EXTRA_DIST
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@573 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-07-17 11:23:13 +00:00
Enrico Tröger
7f481ca16b Fixed wrong dependency in target 'install'.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@529 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-07-03 11:31:00 +00:00
Enrico Tröger
ec7becfe00 Minor improvements.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@526 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-07-02 18:12:34 +00:00
Enrico Tröger
96329e53a5 Added Scintilla license file.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@478 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-06-24 19:37:43 +00:00
Enrico Tröger
26d1a9c028 Fixed a bug which breaks "make install" when xmlto is not installed.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@447 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-06-15 17:31:54 +00:00
Enrico Tröger
11c888b2d7 Renamed target html/index.html in htmldoc, added geany.xsl to EXTRA_DIST.
Removed appendix for keybindings, updated section keybindings to new action identifiers.


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@440 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-06-13 14:51:43 +00:00
Enrico Tröger
59e2d064ea Removed unneeded code for generating geany.1. Added man_MANS to get installed the manpage. Changed build command for HTML documentation. Added new file doc/geany.xsl.
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@422 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-06-08 14:45:14 +00:00
Nick Treleaven
58d7e51ff9 Undo all changes in r393 (oops)
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@394 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-06-02 20:01:57 +00:00
Nick Treleaven
11ffdebfc7 Fix a segfault with missing id in element
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@393 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-06-02 19:47:53 +00:00
Enrico Tröger
2b08b018a9 improved "make uninstall" of Geany
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@196 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-02-14 21:56:34 +00:00
Enrico Tröger
f9acdc464f moved target clean to doc-clean, to hold documentation files during a make clean oder make distclean
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@102 ea778897-0a13-0410-b9d1-a72fbfd435f5
2006-01-03 12:42:29 +00:00
Enrico Tröger
c88044a3ab improved targets to have a clean target and html/index.html target to make the html documentation
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@45 ea778897-0a13-0410-b9d1-a72fbfd435f5
2005-12-11 18:06:07 +00:00
Enrico Tröger
b66995bd1c changed EXTRA_DIST to not include CVS subdirectorys in the generated source tarballs
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@24 ea778897-0a13-0410-b9d1-a72fbfd435f5
2005-11-28 14:52:00 +00:00