From 3888e9dec7a9f1db7e9cfb2e8b0562d95f5153a8 Mon Sep 17 00:00:00 2001 From: Andrew Johnson Date: Tue, 27 Aug 2024 21:58:02 -0500 Subject: [PATCH] Make header file links use Markdown for Sphinx toctree --- documentation/HEADER_h.md | 4 ++++ documentation/HEADER_h.rst | 4 ---- documentation/Makefile | 10 +++++----- 3 files changed, 9 insertions(+), 9 deletions(-) create mode 100644 documentation/HEADER_h.md delete mode 100644 documentation/HEADER_h.rst diff --git a/documentation/HEADER_h.md b/documentation/HEADER_h.md new file mode 100644 index 000000000..8fd0ba69c --- /dev/null +++ b/documentation/HEADER_h.md @@ -0,0 +1,4 @@ +# @HEADER@.h + +```{doxygenfile} @HEADER@.h +``` diff --git a/documentation/HEADER_h.rst b/documentation/HEADER_h.rst deleted file mode 100644 index 5e15e130a..000000000 --- a/documentation/HEADER_h.rst +++ /dev/null @@ -1,4 +0,0 @@ -@HEADER@.h -======================================= - -.. doxygenfile:: @HEADER@.h diff --git a/documentation/Makefile b/documentation/Makefile index 429f7e082..8f509757c 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -130,8 +130,8 @@ menu_HEADERS += menuYesNo HEADER_TYPES = libcom database record menu -HEADER_RST_FILES = $(foreach t, $(HEADER_TYPES), \ - $(addsuffix _h.rst, $($t_HEADERS))) +HEADER_MD_FILES = $(foreach t, $(HEADER_TYPES), \ + $(addsuffix _h.md, $($t_HEADERS))) API_RST_FILES = $(addsuffix -api.rst, $(HEADER_TYPES)) RTD_SRC = $(COMMON_DIR)/rtd-src @@ -141,7 +141,7 @@ DOCS += RELEASE_NOTES.md include $(TOP)/configure/RULES -$(HEADER_RST_FILES): %_h.rst: ../HEADER_h.rst +$(HEADER_MD_FILES): %_h.md: ../HEADER_h.md $(EXPAND_TOOL) -t $(INSTALL_LOCATION) -DHEADER=$* $< $@ $(API_RST_FILES): %-api.rst: ../%-API.rst @@ -160,9 +160,9 @@ doxygen: Doxyfile @$(MKDIR) $(RTD_SRC) $(DOXYGEN) -rtd: doxygen $(API_RST_FILES) $(HEADER_RST_FILES) +rtd: doxygen $(API_RST_FILES) $(HEADER_MD_FILES) rsync -av $(INSTALL_DOC)/ $(RTD_SRC)/ - rsync -av $(HEADER_RST_FILES) $(RTD_SRC)/ + rsync -av $(HEADER_MD_FILES) $(RTD_SRC)/ rsync -av $(API_RST_FILES) $(RTD_SRC)/ rsync -av ../index.rst ../conf.py $(RTD_SRC)/