Mercurial > octave
changeset 24895:088506eadb44 stable
Enable build of a reduced Doxygen version for compressed Qt help file.
Currently a doxygen build is about 2 GB, certainly too much for any file
distribution. Thus `make doxyqt` now creates a complete Doxygen build of about
70 MB without dot graphics and Javascript search tools.
* doc/doxyhtml/Doxyfile.in: Update year. Build Javascipt search engine by
default HTML generation.
* doc/doxyhtml/DoxyfileQt.patch: A patch for Doxyfile.in to make the reduced
build for compressed Qt help files.
* doc/doxyhtml/module.mk: Add target `doxyqt` for reduced build in subfolder
`doxyhtml/doxyqt`. Add new files to build system.
| author | Kai T. Ohlhus <k.ohlhus@gmail.com> |
|---|---|
| date | Thu, 15 Mar 2018 15:01:03 +0100 |
| parents | 655dfe391ec2 |
| children | df131a44310b 91331c76d9c1 |
| files | doc/doxyhtml/Doxyfile.in doc/doxyhtml/DoxyfileQt.patch doc/doxyhtml/module.mk |
| diffstat | 3 files changed, 39 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/doxyhtml/Doxyfile.in Wed Mar 14 23:05:43 2018 -0700 +++ b/doc/doxyhtml/Doxyfile.in Thu Mar 15 15:01:03 2018 +0100 @@ -1,6 +1,6 @@ # -*- mode: conf; -*- -## Copyright (C) 2013-2017 Jordi Gutiérrez Hermoso +## Copyright (C) 2013-2018 Jordi Gutiérrez Hermoso ## ## This file is part of Octave. ## @@ -580,6 +580,27 @@ GENERATE_TREEVIEW = YES +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use <access key> + S +# (what the <access key> is depends on the OS and browser, but it is typically +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down +# key> to jump into the search results window, the results can be navigated +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel +# the search. The filter options can be selected when the cursor is inside the +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> +# to select a filter and <Enter> or <escape> to activate or cancel the filter +# option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +SEARCHENGINE = YES + #--------------------------------------------------------------------------- # Configuration options related to the LaTeX output #---------------------------------------------------------------------------
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/doxyhtml/DoxyfileQt.patch Thu Mar 15 15:01:03 2018 +0100 @@ -0,0 +1,8 @@ + +# The following lines are used to create a minimal version to be used +# as documentation within the GNU Octave GUI widget Qt Assistant. + +HTML_OUTPUT = doxyhtml/doxyqt +HAVE_DOT = NO +GENERATE_TREEVIEW = NO +SEARCHENGINE = NO
--- a/doc/doxyhtml/module.mk Wed Mar 14 23:05:43 2018 -0700 +++ b/doc/doxyhtml/module.mk Thu Mar 15 15:01:03 2018 +0100 @@ -8,16 +8,23 @@ %reldir%/pages/macros.dox \ %reldir%/pages/README.md +doxyqt: %reldir%/Doxyfile $(DOXYGEN_PAGES) | %reldir%/$(octave_dirstamp) + cp %reldir%/Doxyfile %reldir%/DoxyfileQt + cat $(srcdir)/%reldir%/DoxyfileQt.patch >> %reldir%/DoxyfileQt + doxygen %reldir%/DoxyfileQt + doxyhtml: %reldir%/Doxyfile $(DOXYGEN_PAGES) | %reldir%/$(octave_dirstamp) doxygen %reldir%/Doxyfile +# This target is important for in source tree builds. doxyhtml-maintainer-clean: - rm -f %reldir%/pages/README.md - rm -rf `ls -d %reldir%/* 2>/dev/null | $(GREP) -v 'module\.mk\|Doxyfile\.in\|README\|pages$$'` + $(RM) %reldir%/pages/README.md + $(RM) -r `ls -d %reldir%/* 2>/dev/null | $(GREP) -v 'module\.mk\|Doxyfile\.in\|DoxyfileQt\.patch\|README\|pages$$'` doc_EXTRA_DIST += \ $(DOXYGEN_PAGES) \ %reldir%/Doxyfile.in \ + %reldir%/DoxyfileQt.patch \ %reldir%/README DIRSTAMP_FILES += %reldir%/$(octave_dirstamp)