Skip to content

Commit 17c9032

Browse files
cboracbora
committed
docs
1 parent 924a743 commit 17c9032

19 files changed

+1235
-150
lines changed

‎docs/Makefile

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

0 commit comments

Comments
 (0)