Mercurial > octave
changeset 28704:c435048c2796 stable
doc: tidy up Doxygen and no longer build qt help files with Doxygen by default
The HTML output for "https://octave.org/doxygen/" remains untouched, but it
saves the creation of a 2 GB *.qch file by default.
The experiment of displaying the doxygen documenation in the Octave help
browser does still not work properly. For more info see
https://doc.qt.io/qt-5/qthelp-framework.html
* doc/doxyhtml/Doxyfile.in: Remove etc/HACKING.md, which is not included in
distribution tarballs, and the information is of little use here.
* etc/HACKING.md: Remove Doxygen header id hack ^^
* doc/doxyhtml/DoxyfileQt.patch: Remove experiment I added two years ago in
cset 088506eadb44.
* doc/doxyhtml/module.mk: Remove "doxyqt" Makefile target and remove
"DoxyfileQt.patch" from the build system.
* doc/doxyhtml/README.md: Rename from README, improve text.
| author | Kai T. Ohlhus <k.ohlhus@gmail.com> |
|---|---|
| date | Thu, 10 Sep 2020 13:49:46 +0900 |
| parents | c4cf47906bd2 |
| children | cae0d9ab685b f0a3f4527ba6 |
| files | doc/doxyhtml/Doxyfile.in doc/doxyhtml/DoxyfileQt.patch doc/doxyhtml/README doc/doxyhtml/README.md doc/doxyhtml/module.mk etc/HACKING.md |
| diffstat | 6 files changed, 13 insertions(+), 30 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/doxyhtml/Doxyfile.in Sun May 31 09:56:56 2020 -0700 +++ b/doc/doxyhtml/Doxyfile.in Thu Sep 10 13:49:46 2020 +0900 @@ -385,7 +385,6 @@ @abs_top_srcdir@/liboctave/ \ @abs_top_srcdir@/libinterp \ @abs_top_srcdir@/libgui \ - @abs_top_srcdir@/etc/HACKING.md \ @abs_top_srcdir@/doc/doxyhtml/pages \ @abs_top_builddir@/doc/doxyhtml/pages @@ -503,7 +502,7 @@ # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_QHP = YES +GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to
--- a/doc/doxyhtml/DoxyfileQt.patch Sun May 31 09:56:56 2020 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,8 +0,0 @@ - -# 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/README Sun May 31 09:56:56 2020 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,11 +0,0 @@ -This directory contains documentation in Doxygen format for -Octave's source code. It is not created by default. - -To produce Doxygen documentation use - - make doxyhtml - -Doxygen documentation can be helpful for developers of Octave, but is not -needed by users of Octave. In addition, the documentation requires -approximately 3 GB of storage space. For these reasons it is not maintained -under version control nor distributed in tarballs.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/doxyhtml/README.md Thu Sep 10 13:49:46 2020 +0900 @@ -0,0 +1,9 @@ +This directory contains Doxygen documentation for Octave's source code. +It is not created by default. To generate the Doxygen documentation use + + make doxyhtml + +Doxygen documentation can be helpful for developers of Octave, but is not +needed by users of Octave. In addition, the documentation requires +approximately 3 GB of storage space. For these reasons it is not maintained +under version control nor distributed in tarballs.
--- a/doc/doxyhtml/module.mk Sun May 31 09:56:56 2020 -0700 +++ b/doc/doxyhtml/module.mk Thu Sep 10 13:49:46 2020 +0900 @@ -8,23 +8,17 @@ %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) %reldir%/pages/README.md - $(RM) -r `ls -d %reldir%/* 2>/dev/null | $(GREP) -v 'module\.mk\|Doxyfile\.in\|DoxyfileQt\.patch\|README\|pages$$'` + $(RM) -r `ls -d %reldir%/* 2>/dev/null | $(GREP) -v 'module\.mk\|Doxyfile\.in\|README\|pages$$'` doc_EXTRA_DIST += \ $(DOXYGEN_PAGES) \ %reldir%/Doxyfile.in \ - %reldir%/DoxyfileQt.patch \ - %reldir%/README + %reldir%/README.md DIRSTAMP_FILES += %reldir%/$(octave_dirstamp)