SPHINXOPTS ?= -T

SPHINXBUILD ?= sphinx-build

PAPER =

BUILDDIR = _build

ifneq ($(EXAMPLES_PATTERN),)

EXAMPLES_PATTERN_OPTS := -D sphinx_gallery_conf.filename_pattern="$(EXAMPLES_PATTERN)"

ifeq ($(CI), true)

# On CircleCI using -j2 does not seem to speed up the html-noplot build

SPHINX_NUMJOBS_NOPLOT_DEFAULT=1

else ifeq ($(shell uname), Darwin)

# Avoid stalling issues on MacOS

SPHINX_NUMJOBS_NOPLOT_DEFAULT=1

SPHINX_NUMJOBS_NOPLOT_DEFAULT=auto

PAPEROPT_a4 = -D latex_paper_size=a4

PAPEROPT_letter = -D latex_paper_size=letter

ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)\

$(EXAMPLES_PATTERN_OPTS) .

.PHONY: help clean html dirhtml ziphtml pickle json latex latexpdf changes linkcheck doctest optipng

all: html-noplot

help:

@echo "Please use \`make <target>' where <target> is one of"

@echo " html to make standalone HTML files"

@echo " dirhtml to make HTML files named index.html in directories"

@echo " ziphtml to make a ZIP of the HTML"

@echo " pickle to make pickle files"

@echo " json to make JSON files"

@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"

@echo " latexpdf to make LaTeX files and run them through pdflatex"

@echo " changes to make an overview of all changed/added/deprecated items"

@echo " linkcheck to check all external links for integrity"

@echo " doctest to run all doctests embedded in the documentation (if enabled)"

clean:

-rm -rf $(BUILDDIR)/*

@echo "Removed $(BUILDDIR)/*"

-rm -rf auto_examples/

@echo "Removed auto_examples/"

-rm -rf generated/*

@echo "Removed generated/"

-rm -rf modules/generated/

@echo "Removed modules/generated/"

-rm -rf css/styles/

@echo "Removed css/styles/"

-rm -rf api/*.rst

@echo "Removed api/*.rst"

html: SPHINX_NUMJOBS ?= 1

html:

@echo $(ALLSPHINXOPTS)

# These two lines make the build a bit more lengthy, and the

# the embedding of images more robust

rm -rf $(BUILDDIR)/html/_images

#rm -rf _build/doctrees/

$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) -j$(SPHINX_NUMJOBS) $(BUILDDIR)/html/stable

@echo

@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/stable"

html-noplot: SPHINX_NUMJOBS ?= $(SPHINX_NUMJOBS_NOPLOT_DEFAULT)

html-noplot:

$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) -j$(SPHINX_NUMJOBS) \

$(BUILDDIR)/html/stable

@echo

@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/stable."

dirhtml:

$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

@echo

@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

ziphtml:

@if [ ! -d "$(BUILDDIR)/html/stable/" ]; then \

make html; \

fi

# Optimize the images to reduce the size of the ZIP

optipng $(BUILDDIR)/html/stable/_images/*.png

# Exclude the output directory to avoid infinity recursion

cd $(BUILDDIR)/html/stable; \

zip -q -x _downloads \

-r _downloads/scikit-learn-docs.zip .

@echo

@echo "Build finished. The ZIP of the HTML is in $(BUILDDIR)/html/stable/_downloads."

pickle:

$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle

@echo

@echo "Build finished; now you can process the pickle files."

json:

$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json

@echo

@echo "Build finished; now you can process the JSON files."

latex:

$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

@echo

@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."

@echo "Run \`make' in that directory to run these through (pdf)latex" \

"(use \`make latexpdf' here to do that automatically)."

latexpdf:

$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

@echo "Running LaTeX files through pdflatex..."

make -C $(BUILDDIR)/latex all-pdf

@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

changes:

$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes

@echo

@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:

$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck

@echo

@echo "Link check complete; look for any errors in the above output " \

"or in $(BUILDDIR)/linkcheck/output.txt."

doctest:

$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest

@echo "Testing of doctests in the sources finished, look at the " \

"results in $(BUILDDIR)/doctest/output.txt."

download-data:

python -c "from sklearn.datasets._lfw import _check_fetch_lfw; _check_fetch_lfw()"

optipng:

find _build auto_examples */generated -name '*.png' -print0 \

| xargs -0 -n 1 -P 4 optipng -o10

dist: html ziphtml