doc/src/rtd/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 = rel-notes
  21 src = rel-notes.xfm
  22 imbed_src =
  23 desired_out = rst
  24
  25 include ../master.mk
  26
  27 XPATH = XFM_PATH=.:/usr/local/share/xfm
  28
  29 # -----------------------------------------------------------------------------------
  30
  31 # build and push all .rst files into scraper directory
  32 all:    $(docs:%=%.rst)
  33         cp *.rst ../../../docs/
  34
  35 rel-notes.xfm: always
  36         gen_rel_notes.sh >rel-notes.xfm
  37
  38 rel-notes.rst: rel-notes.xfm $(imbed_src)
  39
  40 # we force the .rst docs to always be out of date so that we don't have to
  41 # jump hoops to ensure that they build for make publish. (See hack rule
  42 # at the end of the file.)
  43 #
  44 $(docs:%=%.rst): always
  45
  46 publish: rel-notes.rst
  47         cp *.rst ../../../docs/
  48
  49 # intermeidate junk that might straggle
  50 clean:
  51         rm -fr *.bcnfile *.ca *.ecnfile *.sp
  52
  53 # Destroy anything that can be built
  54 nuke: clean
  55         rm -fr *.md *.ps *.pdf *.txt *.rst *.toc
  56         rm -fr rel-notes.xfm
  57
  58 # make hack to force a rule to always be out of date
  59 always:
  60