/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         =
 8BUILDDIR      = build
 9
10# User-friendly check for sphinx-build
11ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12$(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/)
13endif
14
15# Internal variables.
16PAPEROPT_a4     = -D latex_paper_size=a4
17PAPEROPT_letter = -D latex_paper_size=letter
18ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19# the i18n builder cannot share the environment and doctrees with the others
20I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21
22.PHONY: help clean html latex linkcheck
23
24html:
25	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
26	@echo
27	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
28
29help:
30	@echo "Use \`make <target>' where <target> is one of"
31	@echo "  html       to make standalone HTML files"
32	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
33	@echo "  linkcheck  to check all external links for integrity"
34	@echo "  clean      to clean up"
35
36latex:
37	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
38	@echo "Running LaTeX files through pdflatex..."
39	$(MAKE) -C $(BUILDDIR)/latex all-pdf
40	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
41
42clean:
43	rm -rf $(BUILDDIR)/*
44
45linkcheck:
46	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
47	@echo
48	@echo "Link check complete; look for any errors in the above output " \
49	      "or in $(BUILDDIR)/linkcheck/output.txt."