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