Skip to content

M
mock-turtle
Commit 3eb377d1 authored by Dimitris Lampridis's avatar Dimitris Lampridis
Browse files
Options

doc: cleanup Makefile and remove doxygen from list PHONY targets to avoid running it every time

parent d2ee19c9
Hide whitespace changes
Inline Side-by-side
Showing with 20 additions and 7 deletions
doc/.gitignore
View file @ 3eb377d1
_*
doxygen-trtl-output/
.doxystamp
doc/Makefile
View file @ 3eb377d1
......@@ -12,20 +12,32 @@ BUILDDIR = _build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile doxygen doxygen-clean
.PHONY: help doxygen
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
%:
$(MAKE) doxygen TARGET=$@
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
GIT_VERSION = $(shell cd $(src); git describe --dirty --long --tags)
GIT_VERSION = $(shell git describe --dirty --long --tags)
doxygen:
ifeq ($(TARGET),clean)
@echo "Remove Doxygen files"
@rm -rf doxygen-trtl-output
@rm -rf doxygen-trtl-output .doxystamp
else
GIT_VERSION=$(GIT_VERSION) EXCLUDE_FILES=$(EXCLUDE_FILES) doxygen ./doxygen-trtl-config
$(MAKE) .doxystamp
endif
# List of Doxygen folders to consider
DOXINPUT = ../software/lib ../software/firmware ../software/include
DOXEXCL = ../software/firmware/scripts ../software/lib/PyMockTurtle ../software/kernel
# List of actual Doxygen source files
FINDEXCL = $(foreach xdir,$(DOXEXCL), ! -path "$(xdir)")
DOXSRC = $(shell find $(DOXINPUT) -type f $(FINDEXCL))
.doxystamp: $(DOXSRC)
GIT_VERSION=$(GIT_VERSION) DOXINPUT="$(DOXINPUT)" DOXEXCL="$(DOXEXCL)" doxygen ./doxygen-trtl-config
@touch .doxystamp
doc/doxygen-trtl-config
View file @ 3eb377d1
......@@ -13,9 +13,9 @@ CASE_SENSE_NAMES = YES
WARN_NO_PARAMDOC = YES
WARN_IF_UNDOCUMENTED = NO
INPUT = ../software/lib ../software/firmware ../software/include
INPUT = $(DOXINPUT)
RECURSIVE = YES
EXCLUDE = ../software/firmware/scripts ../software/lib/PyMockTurtle ../software/kernel
EXCLUDE = $(DOXEXCL)
GENERATE_HTML = NO
GENERATE_LATEX = NO
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment