Use GNU Source-highlight for documentation build

Generate highlighted and line numbered files for the Windows build
scripts to be included in the generated documentation.

Add clean-local target to doc/Makefile.am to clean generated document
files.

Document requirement for GNU Source-highlight.
pull/703/head
Nate Bargmann 2021-05-17 17:35:27 -05:00
rodzic 300da9c8da
commit 2a43303947
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: F72625E2EDBED598
5 zmienionych plików z 58 dodań i 45 usunięć

1
NEWS
Wyświetl plik

@ -8,6 +8,7 @@ Please send Hamlib bug reports to hamlib-developer@lists.sourceforge.net
Version 4.3
* 2021-??-??
* Generating documentation now requires GNU source-highlighter.
Version 4.2
* 2021-05-17

Wyświetl plik

@ -269,6 +269,7 @@ backend. The older version of libusb 0.1.x is no longer supported.
Documentation:
* Doxygen
* GNU Source-highlight
N.B.: Some systems can have several versions of the autotools installed. In
that case, autoconf may be called "autoconf2.59", autoheader

Wyświetl plik

@ -8,5 +8,16 @@ dist_man_MANS = man1/ampctl.1 man1/ampctld.1 \
SRCDOCLST = ../src/rig.c ../src/rotator.c ../src/tones.c ../src/locator.c \
../src/event.c ../src/conf.c ../src/mem.c ../src/settings.c
SCRIPTSLST = build-w32.sh build-w64.sh
# Use GNU source-highlight to generate highlighted shell scripts for the
# Doxygen manual.
doc: hamlib.cfg $(SRCDOCLST)
for script in $(SCRIPTSLST) ; do \
source-highlight -n -i $(top_srcdir)/scripts/$${script} -o $(top_builddir)/scripts/$${script}.html ; \
done ; \
doxygen hamlib.cfg
clean-local:
-rm -rf $(top_builddir)/doc/html $(top_builddir)/scripts/build-w*.sh.html

Wyświetl plik

@ -30,8 +30,8 @@ INCLUDE_PATH = @top_srcdir@/include
EXAMPLE_PATH = @top_srcdir@/tests/testrig.c \
@top_srcdir@ \
@top_srcdir@/scripts/README.build-Windows \
@top_srcdir@/scripts/build-w32.sh \
@top_srcdir@/scripts/build-w64.sh
@top_builddir@/scripts/build-w32.sh.html \
@top_builddir@/scripts/build-w64.sh.html
QUIET = YES

Wyświetl plik

@ -87,9 +87,9 @@ GNU/Linux.
\section Build README.build-Windows
\verbinclude README.build-Windows
\subsection W32 The build-w32.sh script
\include{lineno} build-w32.sh
\htmlinclude build-w32.sh.html
\subsection W64 The build-w64.sh script
\include{lineno} build-w64.sh
\htmlinclude build-w64.sh.html
*/
/*! \page Rdmeosx README.osx