Statistics
| Branch: | Tag: | Revision:

root / docs / Makefile @ eb4ed8c6

History | View | Annotate | Download (1.1 kB)

1
# Makefile for Sphinx documentation
2
#
3

    
4
# You can set these variables from the command line.
5
SPHINXOPTS    =
6
SPHINXBUILD   = sphinx-build
7
EPYBUILD	  = epydoc
8
EPYCONFLOC	  = source
9
APIDIR		  = api
10

    
11
PAPER         =
12
BUILDDIR      = build
13

    
14

    
15
# Internal variables.
16
PAPEROPT_a4     = -D latex_paper_size=a4
17
PAPEROPT_letter = -D latex_paper_size=letter
18
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19

    
20
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
21

    
22
help:
23
	@echo "Please use \`make <target>' where <target> is one of"
24
	@echo "  html      to make standalone sphinx HTML files"
25
	@echo "  api      to make standalone epydoc API files"
26
	
27
clean:
28
	-rm -rf $(BUILDDIR)/*
29

    
30
html:
31
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
32
	@echo
33
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
34

    
35
api:
36
	@mkdir -p $(BUILDDIR)/$(APIDIR)
37
	$(EPYBUILD) -v -c $(EPYCONFLOC)/epydoc.conf --exclude migrations -o $(BUILDDIR)/$(APIDIR) iooclient
38
	@echo
39
	@echo "Build finished. The API pages are in $(BUILDDIR)/$(APIDIR)"
40

    
41