# Makefile for Sphinx documentation
-# Typical usage for Satchmo:
-# make DJANGO_SETTINGS_MODULE=simplestore.settings ROOT_DIR=/path/to/satchmo-working/ html
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-.PHONY: help clean
sphinx-autodoc html web pickle htmlhelp latex changes linkcheck
+.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
@echo "Please use \`make <target>' where <target> is one of"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " changes to make an overview over all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
- @echo "Ensure also that ROOT_DIR is defined (the absolute path to the directory"
- @echo "containing satchmo's apps and projects, usually the parent directory of"
-# Set up a django/satchmo store for sphinx's autodoc.
-# You *must* set this variable from the command line.
- @echo "Please define ROOT_DIR (the absolute path to the directory containing"
- @echo "satchmo's apps and projects, usually the parent directory of this file)."
-# Fallback on the "simple" sample store.
-export DJANGO_SETTINGS_MODULE = simple.settings
-# The separator used in PATH.
-# Use ":" unless WINDOWS is defined (use ";" instead).
-# Indent with space here instead of tabs so that make doesn't treat lines as a
-SATCHMO_APPS = $(ROOT_DIR)/apps
-PROJECT_DIR = $(ROOT_DIR)/projects
-# Set them in the environment so that the sphinx child process find
-export PYTHONPATH = $(shell echo $$PYTHONPATH)$(PATHSEP)$(SATCHMO_APPS)$(PATHSEP)$(PROJECT_DIR)
mkdir -p .build/html .build/doctrees
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
@echo "Build finished. The HTML pages are in .build/html."
mkdir -p .build/pickle .build/doctrees
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle
mkdir -p .build/htmlhelp .build/doctrees
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in .build/htmlhelp."
mkdir -p .build/latex .build/doctrees
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex."
mkdir -p .build/changes .build/doctrees
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes
@echo "The overview file is in .build/changes."
mkdir -p .build/linkcheck .build/doctrees
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck