1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/doc/doxygen/Makefile
2024-10-08 11:34:38 +02:00

48 lines
1.5 KiB
Makefile

RIOTBASE=$(shell git rev-parse --show-toplevel)
# Generate list of quoted absolute include paths. Evaluated in riot.doxyfile.
export STRIP_FROM_INC_PATH_LIST=$(shell \
git ls-tree -dr --full-tree --name-only HEAD core drivers sys |\
grep '/include$$' |\
sed 's/.*/\"$(subst /,\/,$(RIOTBASE))\/\0\"/')
# use lessc (http://lesscss.org/#using-less) for compiling CSS
# It can also be installed in ubuntu with the `node-less` package
LESSC ?= lessc
DOCUMENTATION_FORMAT ?= html
.PHONY: doc
doc: $(DOCUMENTATION_FORMAT)
# by marking html as phony we force make to re-run Doxygen even if the directory exists.
.PHONY: html
html: src/changelog.md
( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | doxygen -
@echo ""
@echo "RIOT documentation successfully generated at file://$(RIOTBASE)/doc/doxygen/html/index.html"
.PHONY: check
check: src/changelog.md
( cat riot.doxyfile) | doxygen -
.PHONY: man
man: src/changelog.md
( cat riot.doxyfile ; echo "GENERATE_MAN = yes" ) | doxygen -
src/css/riot.css: src/css/riot.less src/css/variables.less
@$(LESSC) $< $@
src/css/variables.less: src/config.json
@grep "^\s*\"@" $< | sed -e 's/^\s*"//g' -e 's/":\s*"/: /g' \
-e 's/",\?$$/;/g' -e 's/\\"/"/g' > $@
src/changelog.md: src/changelog.md.tmp ../../release-notes.txt
@./generate-changelog.py $+ $@
.PHONY:
latex: src/changelog.md
( cat riot.doxyfile ; echo "GENERATE_LATEX= yes" ) | doxygen -
clean:
-@rm -rf latex man html doxygen_objdb_*.tmp doxygen_entrydb_*.tmp src/changelog.md