← Back to branch summary

~speijnik/update-manager/debian-gsoc09

« back to all changes in this revision

Viewing changes to doc/Makefile

  • Committer: stephan at peijnik
  • Date: 2009-04-23 16:06:40 UTC
  • Revision ID: stephan@peijnik.at-20090423160640-xbves19on9l7mg0p
Created basic Backend interface classes and their helpers.
Use sphinx to generate documentation for the newly added code.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Makefile
 
1
# Makefile for Sphinx documentation
 
2
#
 
3
 
 
4
# You can set these variables from the command line.
 
5
SPHINXOPTS    =
 
6
SPHINXBUILD   = sphinx-build
 
7
PAPER         =
 
8
 
 
9
# Internal variables.
 
10
PAPEROPT_a4     = -D latex_paper_size=a4
 
11
PAPEROPT_letter = -D latex_paper_size=letter
 
12
ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
13
 
 
14
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
 
15
 
 
16
help:
 
17
        @echo "Please use \`make <target>' where <target> is one of"
 
18
        @echo "  html      to make standalone HTML files"
 
19
        @echo "  pickle    to make pickle files"
 
20
        @echo "  json      to make JSON files"
 
21
        @echo "  htmlhelp  to make HTML files and a HTML help project"
 
22
        @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 
23
        @echo "  changes   to make an overview over all changed/added/deprecated items"
 
24
        @echo "  linkcheck to check all external links for integrity"
 
25
 
 
26
clean:
 
27
        -rm -rf build/*
 
28
 
 
29
html:
 
30
        mkdir -p build/html build/doctrees
 
31
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
 
32
        @echo
 
33
        @echo "Build finished. The HTML pages are in build/html."
 
34
 
 
35
pickle:
 
36
        mkdir -p build/pickle build/doctrees
 
37
        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
 
38
        @echo
 
39
        @echo "Build finished; now you can process the pickle files."
 
40
 
 
41
web: pickle
 
42
 
 
43
json:
 
44
        mkdir -p build/json build/doctrees
 
45
        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
 
46
        @echo
 
47
        @echo "Build finished; now you can process the JSON files."
 
48
 
 
49
htmlhelp:
 
50
        mkdir -p build/htmlhelp build/doctrees
 
51
        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
 
52
        @echo
 
53
        @echo "Build finished; now you can run HTML Help Workshop with the" \
 
54
              ".hhp project file in build/htmlhelp."
 
55
 
 
56
latex:
 
57
        mkdir -p build/latex build/doctrees
 
58
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
 
59
        @echo
 
60
        @echo "Build finished; the LaTeX files are in build/latex."
 
61
        @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
 
62
              "run these through (pdf)latex."
 
63
 
 
64
changes:
 
65
        mkdir -p build/changes build/doctrees
 
66
        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
 
67
        @echo
 
68
        @echo "The overview file is in build/changes."
 
69
 
 
70
linkcheck:
 
71
        mkdir -p build/linkcheck build/doctrees
 
72
        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
 
73
        @echo
 
74
        @echo "Link check complete; look for any errors in the above output " \
 
75
              "or in build/linkcheck/output.txt."