Branch: refs/heads/master
Author: Colomban Wendling <ban(a)herbesfolles.org>
Committer: Colomban Wendling <ban(a)herbesfolles.org>
Date: Fri, 29 Aug 2014 15:06:51 UTC
Commit: 666fdf30fa776566dbbaccaaf7aec67427b2e322
https://github.com/geany/geany/commit/666fdf30fa776566dbbaccaaf7aec67427b2e…
Log Message:
-----------
Document document_find_by_id() parameter so Doxygen is happy
Modified Paths:
--------------
src/document.c
Modified: src/document.c
1 lines changed, 1 insertions(+), 0 deletions(-)
===================================================================
@@ -233,6 +233,7 @@ GeanyDocument *document_find_by_sci(ScintillaObject *sci)
/** Lookup an old document by its ID.
* Useful when the corresponding document may have been closed since the
* ID was retrieved.
+ * @param id The ID of the document to find
* @return @c NULL if the document is no longer open.
*
* Example:
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
Branch: refs/heads/master
Author: Colomban Wendling <ban(a)herbesfolles.org>
Committer: Colomban Wendling <ban(a)herbesfolles.org>
Date: Fri, 29 Aug 2014 15:05:18 UTC
Commit: 7125075168198f00f66001cbeaeb3d2318c0abf7
https://github.com/geany/geany/commit/7125075168198f00f66001cbeaeb3d2318c0a…
Log Message:
-----------
Fix HTML documentation installation for VPATH builds
Modified Paths:
--------------
doc/Makefile.am
Modified: doc/Makefile.am
5 lines changed, 4 insertions(+), 1 deletions(-)
===================================================================
@@ -113,6 +113,9 @@ uninstall-local:
# manually install some files under another name
install-data-local:
$(mkinstalldirs) $(DOCDIR)/html
- $(INSTALL_DATA) $(srcdir)/geany.html $(DOCDIR)/html/index.html
+# as we don't install with the automated mechanism so we can rename the file,
+# we need to find the source file in the right location (either builddir or srcdir)
+ dir=$(builddir); test -f "$$dir/geany.html" || dir=$(srcdir); \
+ $(INSTALL_DATA) "$$dir/geany.html" $(DOCDIR)/html/index.html
$(INSTALL_DATA) $(srcdir)/geany.txt $(DOCDIR)/manual.txt
$(INSTALL_DATA) $(top_srcdir)/scintilla/License.txt $(DOCDIR)/ScintillaLicense.txt
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
Branch: refs/heads/master
Author: Colomban Wendling <ban(a)herbesfolles.org>
Committer: Colomban Wendling <ban(a)herbesfolles.org>
Date: Fri, 29 Aug 2014 15:05:18 UTC
Commit: 0453991a61c57550555327707c3ecdefcf4de009
https://github.com/geany/geany/commit/0453991a61c57550555327707c3ecdefcf4de…
Log Message:
-----------
Don't try to install the HTML documentation if we don't have it
Modified Paths:
--------------
doc/Makefile.am
m4/geany-docutils.m4
Modified: doc/Makefile.am
5 lines changed, 5 insertions(+), 0 deletions(-)
===================================================================
@@ -1,5 +1,6 @@
man_MANS=geany.1
+if INSTALL_HTML_DOCS
htmldocimagesdir = $(docdir)/html/images
dist_htmldocimages_DATA = \
images/build_menu_commands_dialog.png \
@@ -23,6 +24,7 @@ dist_htmldocimages_DATA = \
images/pref_dialog_various.png \
images/pref_dialog_vte.png \
images/replace_dialog.png
+endif
doc_DATA = \
$(top_srcdir)/AUTHORS \
@@ -112,10 +114,13 @@ uninstall-local:
# manually install some files under another name
install-data-local:
+if INSTALL_HTML_DOCS
$(mkinstalldirs) $(DOCDIR)/html
# as we don't install with the automated mechanism so we can rename the file,
# we need to find the source file in the right location (either builddir or srcdir)
dir=$(builddir); test -f "$$dir/geany.html" || dir=$(srcdir); \
$(INSTALL_DATA) "$$dir/geany.html" $(DOCDIR)/html/index.html
+endif
+ $(mkinstalldirs) $(DOCDIR)
$(INSTALL_DATA) $(srcdir)/geany.txt $(DOCDIR)/manual.txt
$(INSTALL_DATA) $(top_srcdir)/scintilla/License.txt $(DOCDIR)/ScintillaLicense.txt
Modified: m4/geany-docutils.m4
8 lines changed, 7 insertions(+), 1 deletions(-)
===================================================================
@@ -14,10 +14,14 @@ AC_DEFUN([GEANY_CHECK_DOCUTILS_HTML],
[
AC_REQUIRE([GEANY_CHECK_REVISION])
+ AS_IF([test -f "$srcdir/doc/geany.html"],
+ [have_prebuilt_html_docs=yes],
+ [have_prebuilt_html_docs=no])
+
dnl we require rst2html by default unless we don't build from Git
dnl and already have the HTML manual built in-tree
html_docs_default=yes
- AS_IF([test "$REVISION" = "-1" && test -f "$srcdir/doc/geany.html"],
+ AS_IF([test "$REVISION" = "-1" && test "x$have_prebuilt_html_docs" = xyes],
[html_docs_default=auto])
AC_ARG_ENABLE([html-docs],
@@ -40,6 +44,8 @@ but you then may not have a local copy of the HTML manual.])],
[geany_enable_html_docs="no"])
])
AM_CONDITIONAL([WITH_RST2HTML], [test "x$geany_enable_html_docs" != "xno"])
+ AM_CONDITIONAL([INSTALL_HTML_DOCS], [test "x$geany_enable_html_docs" != "xno" ||
+ test "x$have_prebuilt_html_docs" = xyes])
GEANY_STATUS_ADD([Build HTML documentation], [$geany_enable_html_docs])
])
dnl
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
Branch: refs/heads/master
Author: Enrico Tröger <enrico.troeger(a)uvena.de>
Committer: Enrico Tröger <enrico.troeger(a)uvena.de>
Date: Fri, 29 Aug 2014 13:40:47 UTC
Commit: 9307a6877c75169118672e453c55b54fd9a6ab3b
https://github.com/geany/geany/commit/9307a6877c75169118672e453c55b54fd9a6a…
Log Message:
-----------
Explicitly specify extensions when searching for rst2html
This is cleaner than searching for rst2html and rst2html.py since Waf
offers the API for this and this change enables Windows support.
While at it, add binary name 'rst2html2' for ArchLinux support.
Modified Paths:
--------------
wscript
Modified: wscript
4 lines changed, 2 insertions(+), 2 deletions(-)
===================================================================
@@ -721,9 +721,9 @@ def _find_program(ctx, cmd, **kw):
def _find_rst2html(ctx):
- cmds = ['rst2html.py', 'rst2html']
+ cmds = ['rst2html', 'rst2html2']
for command in cmds:
- cmd = _find_program(ctx, command, mandatory=False)
+ cmd = _find_program(ctx, command, mandatory=False, exts=',.py')
if cmd:
break
if not cmd:
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
Branch: refs/heads/master
Author: Enrico Tröger <enrico.troeger(a)uvena.de>
Committer: Enrico Tröger <enrico.troeger(a)uvena.de>
Date: Fri, 29 Aug 2014 12:39:26 UTC
Commit: 6ecf750759b0611542586818b27a0638f23fb97f
https://github.com/geany/geany/commit/6ecf750759b0611542586818b27a0638f23fb…
Log Message:
-----------
The missing bits for HTML docs: only on GIT build and support in-tree geany.html
Modified Paths:
--------------
wscript
Modified: wscript
10 lines changed, 6 insertions(+), 4 deletions(-)
===================================================================
@@ -232,8 +232,10 @@ def configure(conf):
conf.env['minimum_gtk_version'] = minimum_gtk_version
conf.env['use_gtk3'] = conf.options.use_gtk3
+ revision = _get_git_rev(conf)
+
# rst2html for the HTML manual
- if not conf.options.no_html_doc:
+ if not conf.options.no_html_doc and revision is not None:
try:
conf.env['RST2HTML'] = _find_rst2html(conf)
except WafError:
@@ -275,8 +277,6 @@ but you then may not have a local copy of the HTML manual.'''
_define_from_opt(conf, 'LIBDIR', conf.options.libdir, libdir)
_define_from_opt(conf, 'MANDIR', conf.options.mandir, mandir)
- revision = _get_git_rev(conf)
-
conf.define('ENABLE_NLS', 1)
conf.define('GEANY_LOCALEDIR', '' if is_win32 else conf.env['LOCALEDIR'], quote=True)
conf.define('GEANY_DATADIR', 'data' if is_win32 else conf.env['DATADIR'], quote=True)
@@ -565,7 +565,9 @@ def build(bld):
bld.install_as(destination, filename)
# install HTML documentation only if it exists, i.e. it was built before
- if os.path.exists(html_doc_filename):
+ # local_html_doc_filename supports installing HTML doc from in-tree geany.html if it exists
+ local_html_doc_filename = os.path.join(bld.path.abspath(), 'doc', 'geany.html')
+ if os.path.exists(html_doc_filename) or os.path.exists(local_html_doc_filename):
html_dir = '' if is_win32 else 'html/'
html_name = 'Manual.html' if is_win32 else 'index.html'
start_dir = bld.path.find_dir('doc/images')
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
Branch: refs/heads/master
Author: Enrico Tröger <enrico.troeger(a)uvena.de>
Committer: Enrico Tröger <enrico.troeger(a)uvena.de>
Date: Fri, 29 Aug 2014 12:27:12 UTC
Commit: 8961f0b6e96de3591aa30b3886572147c4321c2f
https://github.com/geany/geany/commit/8961f0b6e96de3591aa30b3886572147c4321…
Log Message:
-----------
Add option --disable-html-docs
Modified Paths:
--------------
wscript
Modified: wscript
12 lines changed, 11 insertions(+), 1 deletions(-)
===================================================================
@@ -233,7 +233,14 @@ def configure(conf):
conf.env['use_gtk3'] = conf.options.use_gtk3
# rst2html for the HTML manual
- conf.env['RST2HTML'] = _find_rst2html(conf)
+ if not conf.options.no_html_doc:
+ try:
+ conf.env['RST2HTML'] = _find_rst2html(conf)
+ except WafError:
+ error_msg = '''Documentation enabled but rst2html not found.
+You can explicitly disable building of the HTML manual with --disable-html-docs,
+but you then may not have a local copy of the HTML manual.'''
+ raise WafError(error_msg)
# Windows specials
if is_win32:
@@ -336,6 +343,9 @@ def options(opt):
opt.add_option('--enable-gtk3', action='store_true', default=False,
help='compile with GTK3 support (experimental) [[default: No]',
dest='use_gtk3')
+ opt.add_option('--disable-html-docs', action='store_true', default=False,
+ help='do not generate HTML documentation using rst2html [[default: No]',
+ dest='no_html_doc')
# Paths
opt.add_option('--mandir', type='string', default='',
help='man documentation', dest='mandir')
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).