documentation/makefile

   1
   2 export DEFINITIONS
   3   # ensure that the macros get passed down to the subprocesses.
   4
   5 include cpp/variables.def
   6
   7 PROJECT = Source_Documentation
   8 TYPE = application
   9 FIRST_TARGETS += build_docs
  10
  11 include cpp/rules.def
  12
  13 build_docs:
  14 #       @echo the defs are $(DEFINITIONS)
  15         @echo Regenerating documentation for feisty meow with doxygen.  This could take a while...
  16         $(HIDESH) -c '\
  17 outfile="$$TEMPORARIES_PILE/doxygen_run_$$(date +"%Y%m%d%H%M%S").log"; \
  18 doxygen $(wildcard *.config) &> "$$outfile"; \
  19 if [ $$? -ne 0 ]; then \
  20   echo failed to run doxygen on our configuration file.; \
  21   echo perhaps doxygen is not properly installed?; \
  22   echo these are the ubuntu install steps:; \
  23   echo   sudo apt install doxygen graphviz; \
  24 fi; \
  25 \rm -f "$$outfile" \
  26 '
  27         @echo ...done regenerating the feisty meow docs.
  28
  29 clean_docs:
  30         @echo dropping code_guide contents.
  31         $(HIDESH) -c '\
  32 for dir in ../production/code_guide; do \
  33   for patt in html map md5 png js css ttf dot ; do \
  34     rm -f $$dir/*.$$patt; \
  35   done; \
  36 done \
  37 '
  38
  39