/doc/Makefile

Relevant Search: With Applications for Solr and Elasticsearch

For more in depth reading about search, ranking and generally everything you could ever want to know about how lucene, elasticsearch or solr work under the hood I highly suggest this book. Easily one of the most interesting technical books I have read in a long time. If you are tasked with solving search relevance problems even if not in Solr or Elasticsearch it should be your first reference. Amazon Affiliate Link

 1# Makefile for Sphinx documentation
 2#
 3
 4# You can set these variables from the command line.
 5SPHINXOPTS    =
 6SPHINXBUILD   = sphinx-build
 7PAPER         =
 8
 9# Internal variables.
10PAPEROPT_a4     = -D latex_paper_size=a4
11PAPEROPT_letter = -D latex_paper_size=letter
12ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13
14.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
15
16help:
17	@echo "Please use \`make <target>' where <target> is one of"
18	@echo "  html      to make standalone HTML files"
19	@echo "  dirhtml   to make HTML files named index.html in directories"
20	@echo "  pickle    to make pickle files"
21	@echo "  json      to make JSON files"
22	@echo "  htmlhelp  to make HTML files and a HTML help project"
23	@echo "  qthelp    to make HTML files and a qthelp project"
24	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
25	@echo "  changes   to make an overview of all changed/added/deprecated items"
26	@echo "  linkcheck to check all external links for integrity"
27	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
28
29clean:
30	-rm -rf _build/*
31
32html:
33	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
34	@echo
35	rsync -t --recursive _build/html/* /home/lg/public_html/oss/ruffus
36	#../../ruffus_docs_sync.cmd
37	@echo "Build finished. The HTML pages are in _build/html."
38
39dirhtml:
40	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
41	@echo
42	@echo "Build finished. The HTML pages are in _build/dirhtml."
43
44pickle:
45	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
46	@echo
47	@echo "Build finished; now you can process the pickle files."
48
49json:
50	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
51	@echo
52	@echo "Build finished; now you can process the JSON files."
53
54htmlhelp:
55	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
56	@echo
57	@echo "Build finished; now you can run HTML Help Workshop with the" \
58	      ".hhp project file in _build/htmlhelp."
59
60qthelp:
61	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
62	@echo
63	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
64	      ".qhcp project file in _build/qthelp, like this:"
65	@echo "# qcollectiongenerator _build/qthelp/pypeline.qhcp"
66	@echo "To view the help file:"
67	@echo "# assistant -collectionFile _build/qthelp/pypeline.qhc"
68
69latex:
70	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
71	@echo
72	@echo "Build finished; the LaTeX files are in _build/latex."
73	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
74	      "run these through (pdf)latex."
75
76changes:
77	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
78	@echo
79	@echo "The overview file is in _build/changes."
80
81linkcheck:
82	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
83	@echo
84	@echo "Link check complete; look for any errors in the above output " \
85	      "or in _build/linkcheck/output.txt."
86
87doctest:
88	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
89	@echo "Testing of doctests in the sources finished, look at the " \
90	      "results in _build/doctest/output.txt."
91	      
92
93pdf:
94	$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) _build/pdf
95	@echo
96	@echo "Build finished. The PDF files are in _build/pdf."