Skip to content

Commit 05cce32

Browse files
dschreijdschreij
committed
Move docs to here
1 parent 4eb543f commit 05cce32

File tree

6 files changed

+964
-0
lines changed

6 files changed

+964
-0
lines changed

‎docs/Makefile

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

0 commit comments

Comments
 (0)