1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS    =
6SPHINXBUILD   = sphinx-build
7PAPER         =
8BUILDDIR      = _build
9
10STAGEDIR = .
11
12# Internal variables.
13PAPEROPT_a4     = -D latex_paper_size=a4
14PAPEROPT_letter = -D latex_paper_size=letter
15ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
16
17.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
18
19help:
20	@echo "Please use \`make <target>' where <target> is one of"
21	@echo "  html       to make standalone HTML files"
22	@echo "  dirhtml    to make HTML files named index.html in directories"
23	@echo "  singlehtml to make a single large HTML file"
24	@echo "  pickle     to make pickle files"
25	@echo "  json       to make JSON files"
26	@echo "  htmlhelp   to make HTML files and a HTML help project"
27	@echo "  qthelp     to make HTML files and a qthelp project"
28	@echo "  devhelp    to make HTML files and a Devhelp project"
29	@echo "  epub       to make an epub"
30	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
32	@echo "  text       to make text files"
33	@echo "  man        to make manual pages"
34	@echo "  changes    to make an overview of all changed/added/deprecated items"
35	@echo "  linkcheck  to check all external links for integrity"
36	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
37
38clean:
39	-rm -rf $(BUILDDIR)/*
40
41html:
42	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
43	@echo
44	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
45	cp -a $(BUILDDIR)/html $(STAGEDIR)
46	@echo "Copied to $(STAGEDIR)/html"
47
48dirhtml:
49	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
50	@echo
51	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
52
53singlehtml:
54	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
55	@echo
56	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
57
58pickle:
59	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
60	@echo
61	@echo "Build finished; now you can process the pickle files."
62
63json:
64	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
65	@echo
66	@echo "Build finished; now you can process the JSON files."
67
68htmlhelp:
69	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
70	@echo
71	@echo "Build finished; now you can run HTML Help Workshop with the" \
72	      ".hhp project file in $(BUILDDIR)/htmlhelp."
73
74qthelp:
75	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
76	@echo
77	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
78	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
79	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Astrometrynet.qhcp"
80	@echo "To view the help file:"
81	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Astrometrynet.qhc"
82
83devhelp:
84	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
85	@echo
86	@echo "Build finished."
87	@echo "To view the help file:"
88	@echo "# mkdir -p $$HOME/.local/share/devhelp/Astrometrynet"
89	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Astrometrynet"
90	@echo "# devhelp"
91
92epub:
93	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
94	@echo
95	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
96
97latex:
98	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
99	@echo
100	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
101	@echo "Run \`make' in that directory to run these through (pdf)latex" \
102	      "(use \`make latexpdf' here to do that automatically)."
103
104latexpdf:
105	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
106	@echo "Running LaTeX files through pdflatex..."
107	make -C $(BUILDDIR)/latex all-pdf
108	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
109
110text:
111	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
112	@echo
113	@echo "Build finished. The text files are in $(BUILDDIR)/text."
114
115man:
116	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
117	@echo
118	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
119
120changes:
121	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
122	@echo
123	@echo "The overview file is in $(BUILDDIR)/changes."
124
125linkcheck:
126	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
127	@echo
128	@echo "Link check complete; look for any errors in the above output " \
129	      "or in $(BUILDDIR)/linkcheck/output.txt."
130
131doctest:
132	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
133	@echo "Testing of doctests in the sources finished, look at the " \
134	      "results in $(BUILDDIR)/doctest/output.txt."
135