Branch: refs/heads/master Author: Colomban Wendling ban@herbesfolles.org Committer: Colomban Wendling ban@herbesfolles.org Date: Wed, 27 Aug 2014 17:06:22 UTC Commit: 102169ee3200176178bfd2290ae5db45b545df4f https://github.com/geany/geany/commit/102169ee3200176178bfd2290ae5db45b545df...
Log Message: ----------- Merge branch 'doc/untrack-geany.html'
Closes PR#322.
Modified Paths: -------------- .gitignore doc/Makefile.am doc/geany.html m4/geany-docutils.m4 wscript
Modified: .gitignore 1 lines changed, 1 insertions(+), 0 deletions(-) =================================================================== @@ -99,6 +99,7 @@ Makefile.in /doc/Doxyfile /doc/Doxyfile.stamp /doc/geany.1 +/doc/geany.html /doc/hacking.html /doc/*.pdf /doc/*.aux
Modified: doc/Makefile.am 28 lines changed, 11 insertions(+), 17 deletions(-) =================================================================== @@ -56,16 +56,17 @@ geany.html: $(srcdir)/geany.css $(srcdir)/geany.txt hacking.html: $(srcdir)/geany.css $(top_srcdir)/HACKING $(AM_V_GEN)$(RST2HTML) -stg --stylesheet=$(srcdir)/geany.css $(top_srcdir)/HACKING $@
-all-html-local: geany.html hacking.html +all-local: geany.html hacking.html
+# clean on 'maintainer-clean' rather than 'clean' in case it was not +# built by Make but rather part of the distribution. This is fine even +# then, as configure will properly require what is needed to build it +# again if it is missing. +maintainer-clean-local: clean-html-local clean-html-local: -rm -f hacking.html -# FIXME: why is the generated HTML manual checked-in to VCS? -# -rm -f geany.html + -rm -f geany.html
-else -all-html-local:; -clean-html-local:; endif
# PDF user manual @@ -74,14 +75,12 @@ if WITH_RST2PDF geany-$(VERSION).pdf: geany.txt $(AM_V_GEN)$(RST2PDF) $(srcdir)/geany.txt -o $@
-all-pdf-local: geany-$(VERSION).pdf +all-local: geany-$(VERSION).pdf
+clean-local: clean-pdf-local clean-pdf-local: -rm -f geany-$(VERSION).pdf
-else -all-pdf-local:; -clean-pdf-local:; endif
# API Documentation @@ -100,19 +99,14 @@ doxygen_sources = \ Doxyfile.stamp: Doxyfile $(doxygen_sources) $(AM_V_GEN)$(DOXYGEN) Doxyfile && echo "" > $@
-all-api-docs-local: Doxyfile.stamp +all-local: Doxyfile.stamp
+clean-local: clean-api-docs-local clean-api-docs-local: -rm -rf reference/ Doxyfile.stamp
-else -all-api-docs-local:; -clean-api-docs-local:; endif
-all-local: all-html-local all-pdf-local all-api-docs-local -clean-local: clean-html-local clean-pdf-local clean-api-docs-local - uninstall-local: rm -rf $(DOCDIR);
Modified: doc/geany.html 6970 lines changed, 0 insertions(+), 6970 deletions(-) =================================================================== No diff available, check online
Modified: m4/geany-docutils.m4 20 lines changed, 15 insertions(+), 5 deletions(-) =================================================================== @@ -12,11 +12,19 @@ dnl For HTML documentation generation dnl AC_DEFUN([GEANY_CHECK_DOCUTILS_HTML], [ + AC_REQUIRE([GEANY_CHECK_REVISION]) + + 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"], + [html_docs_default=auto]) + AC_ARG_ENABLE([html-docs], [AS_HELP_STRING([--enable-html-docs], - [generate HTML documentation using rst2html [default=no]])], + [generate HTML documentation using rst2html [default=auto]])], [geany_enable_html_docs="$enableval"], - [geany_enable_html_docs="no"]) + [geany_enable_html_docs="$html_docs_default"]) AC_ARG_VAR([RST2HTML], [Path to Docutils rst2html executable]) AS_IF([test "x$geany_enable_html_docs" != "xno"], [ @@ -26,7 +34,9 @@ dnl TODO: try rst2html.py first AS_IF([test "x$RST2HTML" != "xno"], [geany_enable_html_docs="yes"], [test "x$geany_enable_html_docs" = "xyes"], - [AC_MSG_ERROR([Documentation enabled but rst2html not found])], + [AC_MSG_ERROR([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.])], [geany_enable_html_docs="no"]) ]) AM_CONDITIONAL([WITH_RST2HTML], [test "x$geany_enable_html_docs" != "xno"]) @@ -40,9 +50,9 @@ AC_DEFUN([GEANY_CHECK_DOCUTILS_PDF], [ AC_ARG_ENABLE([pdf-docs], [AS_HELP_STRING([--enable-pdf-docs], - [generate PDF documentation using rst2pdf [default=no]])], + [generate PDF documentation using rst2pdf [default=auto]])], [geany_enable_pdf_docs="$enableval"], - [geany_enable_pdf_docs="no"]) + [geany_enable_pdf_docs="auto"]) AC_ARG_VAR([RST2PDF], [Path to Docutils rst2pdf executable]) AS_IF([test "x$geany_enable_pdf_docs" != "xno"], [
Modified: wscript 5 lines changed, 5 insertions(+), 0 deletions(-) =================================================================== @@ -514,6 +514,11 @@ def build(bld): 'top_builddir': bld.out_dir, 'top_srcdir': bld.top_dir,})
+ # build HTML documentation if it is not part of the tree already, as it is required for install + # FIXME: replace this with automatic building if source changed/destination is missing + if not bld.path.find_resource('doc/geany.html'): + htmldoc(bld) + ### # Install files ###
-------------- This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).