~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Ian Clatworthy
  • Date: 2009-09-08 12:48:04 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090908124804-inswmhqh1bbq73tx
Update Makefile: use doc/en instead of doc, only html by default, more comments

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
77
77
# these are treated as phony so they'll always be rebuilt - it's pretty quick
78
78
.PHONY: TAGS tags
79
79
 
 
80
 
80
81
### Documentation ###
81
82
 
82
 
# Build the documentation in the default set of formats
83
 
docs: html-docs pdf-docs
 
83
# Build the documentation. To keep the dependencies down to a minimum
 
84
# for distro packagers, we only build the html documentation by default.
 
85
# Sphinx 0.6 or later is required. See http://sphinx.pocoo.org/index.html
 
86
# for installation instructions.
 
87
docs: html-docs
84
88
 
85
89
# Clean out generated documentation
86
90
clean-docs:
87
 
        cd doc && make clean
 
91
        cd doc/en && make clean
88
92
        cd doc/es && make clean
89
93
        cd doc/ru && make clean
90
94
        cd doc/developers && make clean
91
95
 
92
96
DOC_DEPENDENCIES = doc/en/release-notes/NEWS.txt doc/en/user-reference/bzr_man.txt
93
97
 
94
 
# Build the html docs. Requires Sphinx.
 
98
# Build the html docs. Requires Sphinx 0.6 or later.
95
99
html-docs: $(DOC_DEPENDENCIES)
96
 
        cd doc && make html
 
100
        cd doc/en && make html
97
101
        cd doc/es && make html
98
102
        cd doc/ru && make html
99
103
        cd doc/developers && make html
100
104
 
101
 
# Build the PDF docs. Requires Sphinx and numerous LateX packages.
102
 
# See http://sphinx.pocoo.org/builders.html for details.
 
105
# Build the PDF docs. Requires Sphinx 0.6 or later and numerous LaTeX
 
106
# packages. See http://sphinx.pocoo.org/builders.html for details.
103
107
# Note: We don't currently build PDFs for the Russian docs because
104
108
# they require additional packages to be installed (to handle
105
109
# Russian hyphenation rules, etc.)
106
110
pdf-docs: $(DOC_DEPENDENCIES)
107
 
        cd doc && make latex
 
111
        cd doc/en && make latex
108
112
        cd doc/es && make latex
109
113
        cd doc/developers && make latex
110
 
        cd doc/_build/latex && make all-pdf
 
114
        cd doc/en/_build/latex && make all-pdf
111
115
        cd doc/es/_build/latex && make all-pdf
112
116
        cd doc/developers/_build/latex && make all-pdf
113
117
 
114
 
# Build the CHM (Windows Help) docs. Requires Sphinx and HtmlHelp workshop.
 
118
# Build the CHM (Windows Help) docs. Requires Sphinx 0.6 or later.
 
119
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
 
120
# to generate the final chm files.
115
121
chm-docs: $(DOC_DEPENDENCIES)
116
 
        cd doc && make htmlhelp
 
122
        cd doc/en && make htmlhelp
117
123
        cd doc/es && make htmlhelp
118
124
        cd doc/ru && make htmlhelp
119
125
        cd doc/developers && make htmlhelp