← Back to branch summary

~ibid-core/ibid/trunk

« back to all changes in this revision

Viewing changes to docs/Makefile

  • Committer: Tarmac
  • Author(s): Stefano Rivera
  • Date: 2012-07-31 09:51:02 UTC
  • mfrom: (1043.2.4 sphinxdoc-man)
  • Revision ID: tarmac-20120731095102-ok97by9518vw2bum
Move manpages into Sphinx docs
Author: Stefano Rivera
Merge Request: http://code.launchpad.net/~stefanor/ibid/sphinxdoc-man/+merge/88115
Approved by: Keegan Carruthers-Smith, Jonathan Hitchcock
Fixes LP: #

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/Makefile
5
5
SPHINXOPTS    =
6
6
SPHINXBUILD   = sphinx-build
7
7
PAPER         =
 
8
BUILDDIR      = _build
8
9
 
9
10
# Internal variables.
10
11
PAPEROPT_a4     = -D latex_paper_size=a4
11
12
PAPEROPT_letter = -D latex_paper_size=letter
12
 
ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
13
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13
14
 
14
 
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
 
15
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
15
16
 
16
17
help:
17
18
        @echo "Please use \`make <target>' where <target> is one of"
18
 
        @echo "  html      to make standalone HTML files"
19
 
        @echo "  dirhtml   to make HTML files named index.html in directories"
20
 
        @echo "  pickle    to make pickle files"
21
 
        @echo "  json      to make JSON files"
22
 
        @echo "  htmlhelp  to make HTML files and a HTML help project"
23
 
        @echo "  qthelp    to make HTML files and a qthelp project"
24
 
        @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
25
 
        @echo "  changes   to make an overview of all changed/added/deprecated items"
26
 
        @echo "  linkcheck to check all external links for integrity"
27
 
        @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
 
19
        @echo "  html       to make standalone HTML files"
 
20
        @echo "  dirhtml    to make HTML files named index.html in directories"
 
21
        @echo "  singlehtml to make a single large HTML file"
 
22
        @echo "  pickle     to make pickle files"
 
23
        @echo "  json       to make JSON files"
 
24
        @echo "  htmlhelp   to make HTML files and a HTML help project"
 
25
        @echo "  qthelp     to make HTML files and a qthelp project"
 
26
        @echo "  devhelp    to make HTML files and a Devhelp project"
 
27
        @echo "  epub       to make an epub"
 
28
        @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 
29
        @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 
30
        @echo "  text       to make text files"
 
31
        @echo "  man        to make man pages"
 
32
        @echo "  changes    to make an overview of all changed/added/deprecated items"
 
33
        @echo "  linkcheck  to check all external links for integrity"
 
34
        @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
28
35
 
29
36
clean:
30
 
        -rm -rf _build/*
 
37
        -rm -rf $(BUILDDIR)/*
31
38
 
32
39
html:
33
 
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
 
40
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
34
41
        @echo
35
 
        @echo "Build finished. The HTML pages are in _build/html."
 
42
        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
36
43
 
37
44
dirhtml:
38
 
        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
39
 
        @echo
40
 
        @echo "Build finished. The HTML pages are in _build/dirhtml."
 
45
        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 
46
        @echo
 
47
        @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
48
 
 
49
singlehtml:
 
50
        $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 
51
        @echo
 
52
        @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
41
53
 
42
54
pickle:
43
 
        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
 
55
        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
44
56
        @echo
45
57
        @echo "Build finished; now you can process the pickle files."
46
58
 
47
59
json:
48
 
        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
 
60
        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
49
61
        @echo
50
62
        @echo "Build finished; now you can process the JSON files."
51
63
 
52
64
htmlhelp:
53
 
        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
 
65
        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
54
66
        @echo
55
67
        @echo "Build finished; now you can run HTML Help Workshop with the" \
56
 
              ".hhp project file in _build/htmlhelp."
 
68
              ".hhp project file in $(BUILDDIR)/htmlhelp."
57
69
 
58
70
qthelp:
59
 
        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
 
71
        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
60
72
        @echo
61
73
        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
62
 
              ".qhcp project file in _build/qthelp, like this:"
63
 
        @echo "# qcollectiongenerator _build/qthelp/Ibid.qhcp"
64
 
        @echo "To view the help file:"
65
 
        @echo "# assistant -collectionFile _build/qthelp/Ibid.qhc"
 
74
              ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 
75
        @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Ibid.qhcp"
 
76
        @echo "To view the help file:"
 
77
        @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Ibid.qhc"
 
78
 
 
79
devhelp:
 
80
        $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 
81
        @echo
 
82
        @echo "Build finished."
 
83
        @echo "To view the help file:"
 
84
        @echo "# mkdir -p $$HOME/.local/share/devhelp/Ibid"
 
85
        @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ibid"
 
86
        @echo "# devhelp"
 
87
 
 
88
epub:
 
89
        $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 
90
        @echo
 
91
        @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
66
92
 
67
93
latex:
68
 
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
69
 
        @echo
70
 
        @echo "Build finished; the LaTeX files are in _build/latex."
71
 
        @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
72
 
              "run these through (pdf)latex."
 
94
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 
95
        @echo
 
96
        @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 
97
        @echo "Run \`make' in that directory to run these through (pdf)latex" \
 
98
              "(use \`make latexpdf' here to do that automatically)."
 
99
 
 
100
latexpdf:
 
101
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 
102
        @echo "Running LaTeX files through pdflatex..."
 
103
        $(MAKE) -C $(BUILDDIR)/latex all-pdf
 
104
        @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
105
 
 
106
text:
 
107
        $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 
108
        @echo
 
109
        @echo "Build finished. The text files are in $(BUILDDIR)/text."
 
110
 
 
111
man:
 
112
        $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 
113
        @echo
 
114
        @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
73
115
 
74
116
changes:
75
 
        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
 
117
        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
76
118
        @echo
77
 
        @echo "The overview file is in _build/changes."
 
119
        @echo "The overview file is in $(BUILDDIR)/changes."
78
120
 
79
121
linkcheck:
80
 
        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
 
122
        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
81
123
        @echo
82
124
        @echo "Link check complete; look for any errors in the above output " \
83
 
              "or in _build/linkcheck/output.txt."
 
125
              "or in $(BUILDDIR)/linkcheck/output.txt."
84
126
 
85
127
doctest:
86
 
        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
 
128
        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
87
129
        @echo "Testing of doctests in the sources finished, look at the " \
88
 
              "results in _build/doctest/output.txt."
 
130
              "results in $(BUILDDIR)/doctest/output.txt."