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 # use care: the output type is used to source the macros based on the type
  26 # of output being rendered.
  27 # Two pass builds allow for table of contents gen/insert, forward var
  28 # references etc.
  29 #
  30 %.ps: %.xfm
  31         OUTPUT_TYPE=generic_ps XFM_PASS=1 pfm $< /dev/null
  32         OUTPUT_TYPE=generic_ps XFM_PASS=2 pfm $< $@
  33
  34 %.md: %.xfm
  35         OUTPUT_TYPE=markdown XFM_PASS=1 tfm $< /dev/null
  36         OUTPUT_TYPE=markdown XFM_PASS=2 tfm $< | sed 's/^ //' >$@
  37
  38 %.rst: %.xfm
  39         OUTPUT_TYPE=rst XFM_PASS=1 tfm $< /dev/null
  40         GEN_TITLE=1 OUTPUT_TYPE=rst XFM_PASS=2 tfm $< | sed 's/ $$//; s/^ //' >$@
  41
  42 %.txt: %.xfm
  43         OUTPUT_TYPE=txt XFM_PASS=1 tfm $< /dev/null
  44         OUTPUT_TYPE=txt XFM_PASS=2 tfm $< $@
  45
  46 # -----------------------------------------------------------------------------------
  47
  48 # build and push all .rst files into scraper directory
  49 all:    $(docs:%=%.rst)
  50         cp *.rst ../../../docs/
  51
  52 rel-notes.xfm: always
  53         gen_rel_notes.sh >rel-notes.xfm
  54
  55 rel-notes.rst: rel-notes.xfm $(imbed_src)
  56
  57 # we force the .rst docs to always be out of date so that we don't have to
  58 # jump hoops to ensure that they build for make publish. (See hack rule
  59 # at the end of the file.)
  60 #
  61 $(docs:%=%.rst): always
  62
  63 publish: rel-notes.rst
  64         cp *.rst ../../../docs/
  65
  66 # intermeidate junk that might straggle
  67 clean:
  68         rm -fr *.bcnfile *.ca *.ecnfile *.sp
  69
  70 # Destroy anything that can be built
  71 nuke: clean
  72         rm -fr *.md *.ps *.pdf *.txt *.rst *.toc
  73
  74 # make hack to force a rule to always be out of date
  75 always:
  76