doc/frr-sphinx.mk

   1 # Makefile for Sphinx documentation
   2 #
   3
   4 # You can set these variables from the command line.
   5 SPHINXOPTS    ?=
   6 SPHINXBUILD   ?= sphinx-build
   7 PAPER         ?=
   8 BUILDDIR      = _build
   9
  10 # User-friendly check for sphinx-build
  11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
  12 SPHINXBUILD = sphinx-1.0-build
  13 endif
  14 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
  15 $(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/")
  16 endif
  17
  18 # Internal variables.
  19 PAPEROPT_a4     = -D latex_paper_size=a4
  20 PAPEROPT_letter = -D latex_paper_size=letter
  21 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  22 # the i18n builder cannot share the environment and doctrees with the others
  23 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  24
  25 .PHONY: help
  26 help:
  27         @echo "Please use \`make <target>' where <target> is one of"
  28         @echo "  html       to make standalone HTML files"
  29         @echo "  dirhtml    to make HTML files named index.html in directories"
  30         @echo "  singlehtml to make a single large HTML file"
  31         @echo "  pickle     to make pickle files"
  32         @echo "  json       to make JSON files"
  33         @echo "  htmlhelp   to make HTML files and a HTML help project"
  34         @echo "  qthelp     to make HTML files and a qthelp project"
  35         @echo "  applehelp  to make an Apple Help Book"
  36         @echo "  devhelp    to make HTML files and a Devhelp project"
  37         @echo "  epub       to make an epub"
  38         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  39         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
  40         @echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
  41         @echo "  text       to make text files"
  42         @echo "  man        to make manual pages"
  43         @echo "  texinfo    to make Texinfo files"
  44         @echo "  info       to make Texinfo files and run them through makeinfo"
  45         @echo "  gettext    to make PO message catalogs"
  46         @echo "  changes    to make an overview of all changed/added/deprecated items"
  47         @echo "  xml        to make Docutils-native XML files"
  48         @echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
  49         @echo "  linkcheck  to check all external links for integrity"
  50         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
  51         @echo "  coverage   to run coverage check of the documentation (if enabled)"
  52
  53 .PHONY: clean
  54 clean:
  55         rm -rf $(BUILDDIR)/*
  56
  57 .PHONY: html
  58 html:
  59         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  60         @echo
  61         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  62
  63 .PHONY: dirhtml
  64 dirhtml:
  65         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  66         @echo
  67         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  68
  69 .PHONY: singlehtml
  70 singlehtml:
  71         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  72         @echo
  73         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  74
  75 .PHONY: pickle
  76 pickle:
  77         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  78         @echo
  79         @echo "Build finished; now you can process the pickle files."
  80
  81 .PHONY: json
  82 json:
  83         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  84         @echo
  85         @echo "Build finished; now you can process the JSON files."
  86
  87 .PHONY: htmlhelp
  88 htmlhelp:
  89         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  90         @echo
  91         @echo "Build finished; now you can run HTML Help Workshop with the" \
  92               ".hhp project file in $(BUILDDIR)/htmlhelp."
  93
  94 .PHONY: qthelp
  95 qthelp:
  96         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  97         @echo
  98         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  99               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 100         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FRR.qhcp"
 101         @echo "To view the help file:"
 102         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FRR.qhc"
 103
 104 .PHONY: applehelp
 105 applehelp:
 106         $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
 107         @echo
 108         @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
 109         @echo "N.B. You won't be able to view it unless you put it in" \
 110               "~/Library/Documentation/Help or install it in your application" \
 111               "bundle."
 112
 113 .PHONY: devhelp
 114 devhelp:
 115         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 116         @echo
 117         @echo "Build finished."
 118         @echo "To view the help file:"
 119         @echo "# mkdir -p $$HOME/.local/share/devhelp/FRR"
 120         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FRR"
 121         @echo "# devhelp"
 122
 123 .PHONY: epub
 124 epub:
 125         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 126         @echo
 127         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 128
 129 .PHONY: latex
 130 latex:
 131         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 132         @echo
 133         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 134         @echo "Run \`make' in that directory to run these through (pdf)latex" \
 135               "(use \`make latexpdf' here to do that automatically)."
 136
 137 .PHONY: latexpdf
 138 latexpdf:
 139         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 140         @echo "Running LaTeX files through pdflatex..."
 141         $(MAKE) -C $(BUILDDIR)/latex all-pdf
 142         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 143
 144 .PHONY: latexpdfja
 145 latexpdfja:
 146         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 147         @echo "Running LaTeX files through platex and dvipdfmx..."
 148         $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
 149         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 150
 151 .PHONY: text
 152 text:
 153         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 154         @echo
 155         @echo "Build finished. The text files are in $(BUILDDIR)/text."
 156
 157 .PHONY: man
 158 man:
 159         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 160         @echo
 161         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 162
 163 .PHONY: texinfo
 164 texinfo:
 165         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 166         @echo
 167         @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
 168         @echo "Run \`make' in that directory to run these through makeinfo" \
 169               "(use \`make info' here to do that automatically)."
 170
 171 .PHONY: info
 172 info:
 173         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 174         @echo "Running Texinfo files through makeinfo..."
 175         $(MAKE) -C $(BUILDDIR)/texinfo info
 176         @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
 177
 178 .PHONY: gettext
 179 gettext:
 180         $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
 181         @echo
 182         @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
 183
 184 .PHONY: changes
 185 changes:
 186         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 187         @echo
 188         @echo "The overview file is in $(BUILDDIR)/changes."
 189
 190 .PHONY: linkcheck
 191 linkcheck:
 192         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 193         @echo
 194         @echo "Link check complete; look for any errors in the above output " \
 195               "or in $(BUILDDIR)/linkcheck/output.txt."
 196
 197 .PHONY: doctest
 198 doctest:
 199         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 200         @echo "Testing of doctests in the sources finished, look at the " \
 201               "results in $(BUILDDIR)/doctest/output.txt."
 202
 203 .PHONY: coverage
 204 coverage:
 205         $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
 206         @echo "Testing of coverage in the sources finished, look at the " \
 207               "results in $(BUILDDIR)/coverage/python.txt."
 208
 209 .PHONY: xml
 210 xml:
 211         $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
 212         @echo
 213         @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
 214
 215 .PHONY: pseudoxml
 216 pseudoxml:
 217         $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 218         @echo
 219         @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."