doc/src/user/Makefile

   1 #==================================================================================
   2 #   Copyright (c) 2020 Nokia
   3 #   Copyright (c) 2020 AT&T Intellectual Property.
   4 #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");
   6 #   you may not use this file except in compliance with the License.
   7 #   You may obtain a copy of the License at
   8 #
   9 #       http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #   Unless required by applicable law or agreed to in writing, software
  12 #   distributed under the License is distributed on an "AS IS" BASIS,
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 #   See the License for the specific language governing permissions and
  15 #   limitations under the License.
  16 #==================================================================================
  17
  18 # this uses {X}fm which can be cloned from: https://gitlab.com/rouxware/xfm
  19
  20 docs = user_guide
  21 src = user_guide.xfm
  22 imbed_src = cpp_frame.im example1.im example2.im example3.im jhash.im example4.im metrics.im
  23 desired_out = rst ps md
  24
  25 include ../master.mk
  26
  27 # -----------------------------------------------------------------------------------
  28 all:    $(desired_out:%=user_guide.%)
  29
  30 user_guide.ps: user_guide.xfm $(imbed_src)
  31
  32 # we force the .rst docs to always be out of date so that we don't have to
  33 # jump hoops to ensure that they build for make publish. (See hack rule
  34 # at the end of the file.)
  35 #
  36 $(docs:%=%.rst): always
  37
  38 publish: user_guide.rst
  39         cp user_guide.rst ../../../docs/user-guide.rst
  40
  41 # intermeidate junk that might straggle
  42 clean:
  43         rm -fr *.bcnfile *.ca *.ecnfile *.sp
  44
  45 # Destroy anything that can be built
  46 nuke: clean
  47         rm -fr *.md *.ps *.pdf *.txt *.rst *.toc
  48
  49 # make hack to force a rule to always be out of date
  50 always:
  51