FilesExpand file tree

 main

/

Makefile

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

218 lines (189 loc) · 7.58 KB

 main

/

Makefile

Copy path

Top

File metadata and controls

• Code
• Blame

218 lines (189 loc) · 7.58 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

# Makefile for Sphinx documentation

#

# You can set these variables from the command line.

SPHINXOPTS =

SPHINXBUILD = sphinx-build

PAPER =

BUILDDIR = build

NBCONVERT = ipython nbconvert

# User-friendly check for sphinx-build

ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment 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/)

endif

# Internal variables.

PAPEROPT_a4 = -D latex_paper_size=a4

PAPEROPT_letter = -D latex_paper_size=letter

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

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

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

.PHONY: help

help:

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

@echo " html to make standalone HTML files"

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

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

@echo " pickle to make pickle files"

@echo " json to make JSON files"

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

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

@echo " applehelp to make an Apple Help Book"

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

@echo " epub to make an epub"

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

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

@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"

@echo " text to make text files"

@echo " man to make manual pages"

@echo " texinfo to make Texinfo files"

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

@echo " gettext to make PO message catalogs"

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

@echo " xml to make Docutils-native XML files"

@echo " pseudoxml to make pseudoxml-XML files for display purposes"

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

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

@echo " coverage to run coverage check of the documentation (if enabled)"

.PHONY: clean

clean:

rm -rf $(BUILDDIR)/* source/examples/generated/*

.PHONY: html

html:

make clean

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

@echo

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

.PHONY: dirhtml

dirhtml:

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

@echo

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

.PHONY: singlehtml

singlehtml:

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

@echo

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

.PHONY: pickle

pickle:

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

@echo

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

.PHONY: json

json:

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

@echo

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

.PHONY: htmlhelp

htmlhelp:

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

@echo

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

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

.PHONY: qthelp

qthelp:

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

@echo

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

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

@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-awips.qhcp"

@echo "To view the help file:"

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

.PHONY: applehelp

applehelp:

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

@echo

@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."

@echo "N.B. You won't be able to view it unless you put it in" \

"~/Library/Documentation/Help or install it in your application" \

"bundle."

.PHONY: devhelp

devhelp:

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

@echo

@echo "Build finished."

@echo "To view the help file:"

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

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

@echo "# devhelp"

.PHONY: epub

epub:

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

@echo

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

.PHONY: latex

latex:

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

@echo

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

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

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

.PHONY: latexpdf

latexpdf:

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

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

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

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

.PHONY: latexpdfja

latexpdfja:

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

@echo "Running LaTeX files through platex and dvipdfmx..."

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

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

.PHONY: text

text:

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

@echo

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

.PHONY: man

man:

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

@echo

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

.PHONY: texinfo

texinfo:

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

@echo

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

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

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

.PHONY: info

info:

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

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

make -C $(BUILDDIR)/texinfo info

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

.PHONY: gettext

gettext:

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

@echo

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

.PHONY: changes

changes:

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

@echo

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

.PHONY: linkcheck

linkcheck:

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

@echo

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

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

.PHONY: doctest

doctest:

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

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

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

.PHONY: coverage

coverage:

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

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

"results in $(BUILDDIR)/coverage/python.txt."

.PHONY: xml

xml:

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

@echo

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

.PHONY: pseudoxml

pseudoxml:

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

@echo

@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."