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

# Internal variables.

    11

PAPEROPT_a4     = -D latex_paper_size=a4

    12

PAPEROPT_letter = -D latex_paper_size=letter

    13

ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

    14

# the i18n builder cannot share the environment and doctrees with the others

    15

I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

    16

    17

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

    18

    36

help:

    37

	@echo "Please use \`make <target>' where <target> is one of"

    38

	@echo "  html       to make standalone HTML files"

    39

	@echo "  dirhtml    to make HTML files named index.html in directories"

    40

	@echo "  singlehtml to make a single large HTML file"

    41

	@echo "  pickle     to make pickle files"

    42

	@echo "  json       to make JSON files"

    43

	@echo "  htmlhelp   to make HTML files and a HTML help project"

    44

	@echo "  qthelp     to make HTML files and a qthelp project"

    45

	@echo "  devhelp    to make HTML files and a Devhelp project"

    46

	@echo "  epub       to make an epub"

    47

	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"

    48

	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"

    49

	@echo "  text       to make text files"

    50

	@echo "  man        to make manual pages"

    51

	@echo "  texinfo    to make Texinfo files"

    52

	@echo "  info       to make Texinfo files and run them through makeinfo"

    53

	@echo "  gettext    to make PO message catalogs"

    54

	@echo "  changes    to make an overview of all changed/added/deprecated items"

    55

	@echo "  linkcheck  to check all external links for integrity"

    56

	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"

    57

    58

clean:

    59

	-rm -rf $(BUILDDIR)/*

    60

    61

html:

    62

	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

    63

	@echo

    64

	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

    65

    66

dirhtml:

    67

	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

    68

	@echo

    69

	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

    70

    71

singlehtml:

    72

	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml

    73

	@echo

    74

	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

    75

    76

pickle:

    77

	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle

    78

	@echo

    79

	@echo "Build finished; now you can process the pickle files."

    80

    81

json:

    82

	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json

    83

	@echo

    84

	@echo "Build finished; now you can process the JSON files."

    85

    86

htmlhelp:

    87

	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp

    88

	@echo

    89

	@echo "Build finished; now you can run HTML Help Workshop with the" \

    90

	      ".hhp project file in $(BUILDDIR)/htmlhelp."

    91

    92

qthelp:

    93

	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp

    94

	@echo

    95

	@echo "Build finished; now you can run "qcollectiongenerator" with the" \

    96

	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"

    97

	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Beremiz.qhcp"

    98

	@echo "To view the help file:"

    99

	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Beremiz.qhc"

   100

   101

devhelp:

   102

	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp

   103

	@echo

   104

	@echo "Build finished."

   105

	@echo "To view the help file:"

   106

	@echo "# mkdir -p $$HOME/.local/share/devhelp/Beremiz"

   107

	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Beremiz"

   108

	@echo "# devhelp"

   109

   110

epub:

   111

	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub

   112

	@echo

   113

	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

   114

   115

latex:

   116

	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

   117

	@echo

   118

	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."

   119

	@echo "Run \`make' in that directory to run these through (pdf)latex" \

   120

	      "(use \`make latexpdf' here to do that automatically)."

   121

   122

latexpdf:

   123

	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

   124

	@echo "Running LaTeX files through pdflatex..."

   125

	$(MAKE) -C $(BUILDDIR)/latex all-pdf

   126

	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

   127

   128

text:

   129

	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text

   130

	@echo

   131

	@echo "Build finished. The text files are in $(BUILDDIR)/text."

   132

   133

man:

   134

	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man

   135

	@echo

   136

	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

   137

   138

texinfo:

   139

	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo

   140

	@echo

   141

	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."

   142

	@echo "Run \`make' in that directory to run these through makeinfo" \

   143

	      "(use \`make info' here to do that automatically)."

   144

   145

info:

   146

	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo

   147

	@echo "Running Texinfo files through makeinfo..."

   148

	make -C $(BUILDDIR)/texinfo info

   149

	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

   150

   151

gettext:

   152

	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale

   153

	@echo

   154

	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

   155

   157

changes:

   158

	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes

   159

	@echo

   160

	@echo "The overview file is in $(BUILDDIR)/changes."

   161

   162

linkcheck:

   163

	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck

   164

	@echo

   165

	@echo "Link check complete; look for any errors in the above output " \

   166

	      "or in $(BUILDDIR)/linkcheck/output.txt."

   167

   168

doctest:

   169

	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest

   170

	@echo "Testing of doctests in the sources finished, look at the " \

   171

	      "results in $(BUILDDIR)/doctest/output.txt."