Makefile

Go to the documentation of this file.

##>!
##>! Generate Documentation:
##>!
##>! * Zerocat Chipflasher Documentation (HTML, LATEX, etc.)
##>! * Zerocat Connect Documentation (HTML, LATEX, etc.)
##>! * Zerocat Chipflasher Board Documentation (HTML, LATEX, etc.)
##>!
##>! @file doc/Makefile
##>!
##>! @brief Generate documentation with doxygen.
##>!
 
##>! @cond
### Doxyfile ###
DOXYORIG_CHIPFLASHER       = Doxyfile-Chipflasher.orig
DOXYORIG_CONNECT           = Doxyfile-Connect.orig
DOXYORIG_BOARD             = Doxyfile-Board.orig
DOXYFILE_CHIPFLASHER       = Doxyfile-Chipflasher
DOXYFILE_CONNECT           = Doxyfile-Connect
DOXYFILE_BOARD             = Doxyfile-Board
 
### doxygen ###
DOXYGEN = doxygen
#~ DOXYGEN = /usr/bin/doxygen
#~ DOXYGEN = ~/.guix-profile/bin/doxygen
 
### paths ###
PATH_RESOURCES        = doxygen-resources/
PATH_HARDWARE_DOC     = ../hardware/doc/
PATH_HARDWARE_ARTWORK = ../hardware/artwork/
PATH_HARDWARE_GSCHEM  = ../hardware/gschem/
PATH_HARDWARE_PCB     = ../hardware/pcb/
PATH_FILES            = generated-files/
PATH_IMG              = generated-images/
# Must be same as Doxyfile’s OUTPUT_DIRECTORY:
PATH_DOCUMENTATION    = generated-documentation/
PATH_CHIPFLASHER      = $(PATH_DOCUMENTATION)chipflasher/
PATH_CONNECT          = $(PATH_DOCUMENTATION)connect/
PATH_BOARD            = $(PATH_DOCUMENTATION)board/
 
### messages ###
MSG_ALL = To read the generated html documentation, please open $(PATH_CHIPFLASHER)html/index.html in your browser.
 
### canned commands ###
define canned-doxygenversion
    $(DOXYGEN) --version
endef
define canned-gendoc-chipflasher
    $(DOXYGEN) $(PATH_RESOURCES)$(DOXYFILE_CHIPFLASHER)
    @echo The documentation has been created in: $(PATH_CHIPFLASHER)
endef
define canned-gendoc-connect
    $(DOXYGEN) $(PATH_RESOURCES)$(DOXYFILE_CONNECT)
    @echo The documentation has been created in: $(PATH_CONNECT)
endef
define canned-gendoc-board
    $(DOXYGEN) $(PATH_RESOURCES)$(DOXYFILE_BOARD)
    @echo The documentation has been created in: $(PATH_BOARD)
endef
 
.PHONY: all \
        doxygen-version \
        mkdir-documentation \
        cp-Doxyfiles \
        update-Doxyfiles \
        gen-html-templates-chipflasher \
        gen-html-templates-connect \
        gen-html-templates-board \
        gen-doc-chipflasher \
        gen-doc-connect \
        gen-doc-board \
        gen-doc-chipflasher-tmplnogen \
        gen-doc-connect-tmplnogen \
        gen-doc-board-tmplnogen \
        png-cp bom-cp \
        folder-files folder-img \
        clean \
        cleanall
 
# generate all
all: gen-doc-board gen-doc-connect gen-doc-chipflasher
    @echo $(MSG_ALL)
    @echo
 
doxygen-version:
    $(canned-doxygenversion)
 
mkdir-documentation:
    mkdir -p $(PATH_DOCUMENTATION)
 
cp-Doxyfiles:
    cd $(PATH_RESOURCES) && \
    cp -f $(DOXYORIG_CHIPFLASHER) $(DOXYFILE_CHIPFLASHER) && \
    cp -f $(DOXYORIG_CONNECT) $(DOXYFILE_CONNECT) && \
    cp -f $(DOXYORIG_BOARD) $(DOXYFILE_BOARD)
 
update-Doxyfiles: cp-Doxyfiles
    $(DOXYGEN) -u $(PATH_RESOURCES)$(DOXYFILE_CHIPFLASHER)
    $(DOXYGEN) -u $(PATH_RESOURCES)$(DOXYFILE_CONNECT)
    $(DOXYGEN) -u $(PATH_RESOURCES)$(DOXYFILE_BOARD)
    @echo
    @echo The Doxyfiles have been updated with:
    $(canned-doxygenversion)
    @echo
 
gen-html-templates-chipflasher: update-Doxyfiles
    $(DOXYGEN) -w html \
    $(PATH_RESOURCES)header.html \
    $(PATH_RESOURCES)footer.html \
    $(PATH_RESOURCES)style.css \
    $(PATH_RESOURCES)$(DOXYFILE_CHIPFLASHER)
 
gen-html-templates-connect: update-Doxyfiles
    $(DOXYGEN) -w html \
    $(PATH_RESOURCES)header.html \
    $(PATH_RESOURCES)footer.html \
    $(PATH_RESOURCES)style.css \
    $(PATH_RESOURCES)$(DOXYFILE_CONNECT)
 
gen-html-templates-board: update-Doxyfiles
    $(DOXYGEN) -w html \
    $(PATH_RESOURCES)header.html \
    $(PATH_RESOURCES)footer.html \
    $(PATH_RESOURCES)style.css \
    $(PATH_RESOURCES)$(DOXYFILE_BOARD)
 
# create file folder
folder-files:
    mkdir -p $(PATH_FILES)
 
# create image folder
folder-img:
    mkdir -p $(PATH_IMG)
 
# copy board.png as board.sch.png (used by website)
png-cp: board-make folder-img
    cp $(PATH_HARDWARE_GSCHEM)board.sch.png $(PATH_IMG)board.sch.png
    cp $(PATH_HARDWARE_GSCHEM)cables.sch.png $(PATH_IMG)cables.sch.png
    cp $(PATH_HARDWARE_PCB)board.pcb.png $(PATH_IMG)board.pcb.png
    cp $(PATH_HARDWARE_ARTWORK)front-label.png $(PATH_IMG)front-label.png
    @echo Generated images have been copied to: $(PATH_IMG)
 
# copy generated bom file
bom-cp: board-make folder-files
    cp $(PATH_HARDWARE_DOC)board.bom.md $(PATH_FILES)
    cp $(PATH_HARDWARE_DOC)cables.bom.md $(PATH_FILES)
    @echo The generated BoM-files have been copied to: $(PATH_FILES)
 
# generate chipflasher documentation
gen-doc-chipflasher: mkdir-documentation folder-img gen-html-templates-chipflasher
    $(canned-gendoc-chipflasher)
 
# generate chipflasher documentation with existing resources
gen-doc-chipflasher-tmplnogen: mkdir-documentation folder-img
    $(canned-gendoc-chipflasher)
 
# generate connect documentation
gen-doc-connect: mkdir-documentation folder-img gen-html-templates-connect
    $(canned-gendoc-connect)
 
# generate connect documentation with existing resources
gen-doc-connect-tmplnogen: mkdir-documentation folder-img
    $(canned-gendoc-connect)
 
# generate chipflasher board documentation
gen-doc-board: mkdir-documentation board-make png-cp bom-cp gen-html-templates-board
    $(canned-gendoc-board)
 
# generate chipflasher board documentation with existing resources
gen-doc-board-tmplnogen: mkdir-documentation board-make png-cp bom-cp
    $(canned-gendoc-board)
 
# call Makefile in ../hardware/doc/
board-make:
    $(MAKE) -C $(PATH_HARDWARE_DOC) all
 
# clean:
clean:
    rm -rf $(PATH_FILES) && \
    rm -rf $(PATH_IMG) && \
    rm -rf $(PATH_DOCUMENTATION) && \
    $(MAKE) -C $(PATH_HARDWARE_DOC) clean
    cd $(PATH_RESOURCES) && \
    rm -f header.html footer.html style.css *.bak \
        $(DOXYFILE_CHIPFLASHER) $(DOXYFILE_CONNECT) $(DOXYFILE_BOARD)
 
cleanall: clean
##>! @endcond