EPICS_base/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Make header file links use Markdown for Sphinx toctree

Browse Source
This commit is contained in:
Andrew Johnson
2024-08-27 21:58:02 -05:00
parent af206ba7fc
commit 3888e9dec7
3 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
documentation/HEADER_h.md Normal file
View File

@ -0,0 +1,4 @@
# @HEADER@.h
```{doxygenfile} @HEADER@.h
```

4
documentation/HEADER_h.rst
View File

@ -1,4 +0,0 @@
@HEADER@.h
=======================================
.. doxygenfile:: @HEADER@.h

10
documentation/Makefile
View File

@ -130,8 +130,8 @@ menu_HEADERS += menuYesNo
HEADER_TYPES = libcom database record menu HEADER_TYPES = libcom database record menu
HEADER_RST_FILES = $(foreach t, $(HEADER_TYPES), \ HEADER_MD_FILES = $(foreach t, $(HEADER_TYPES), \
$(addsuffix _h.rst, $($t_HEADERS))) $(addsuffix _h.md, $($t_HEADERS)))
API_RST_FILES = $(addsuffix -api.rst, $(HEADER_TYPES)) API_RST_FILES = $(addsuffix -api.rst, $(HEADER_TYPES))
RTD_SRC = $(COMMON_DIR)/rtd-src RTD_SRC = $(COMMON_DIR)/rtd-src
@ -141,7 +141,7 @@ DOCS += RELEASE_NOTES.md
include $(TOP)/configure/RULES 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=$* $< $@ $(EXPAND_TOOL) -t $(INSTALL_LOCATION) -DHEADER=$* $< $@
$(API_RST_FILES): %-api.rst: ../%-API.rst $(API_RST_FILES): %-api.rst: ../%-API.rst
@ -160,9 +160,9 @@ doxygen: Doxyfile
@$(MKDIR) $(RTD_SRC) @$(MKDIR) $(RTD_SRC)
$(DOXYGEN) $(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 $(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 $(API_RST_FILES) $(RTD_SRC)/
rsync -av ../index.rst ../conf.py $(RTD_SRC)/ rsync -av ../index.rst ../conf.py $(RTD_SRC)/