← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/conf.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-08 12:33:30 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-20090908123330-pjabs6uy7vp3gsad
build the English user docs just like the other languages

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/conf.py
18
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
19
19
#sys.path.append(os.path.abspath('.'))
20
20
 
 
21
 
21
22
# -- Bazaar-specific configuration ---------------------------------------------
22
23
 
23
24
# NOTE: Editing this section is generally all that is required ...
26
27
# the Python path is indeed the one we're building the documentation for ...
27
28
bzr_version = (2, 0, 0, 'rc', 2)
28
29
 
 
30
# The locale code for this documentation set
 
31
bzr_locale = 'en'
 
32
 
 
33
# Authors of the documents
 
34
bzr_team = u'Bazaar Developers'
 
35
 
 
36
# Translations
 
37
bzr_titles = {
 
38
        u'Table of Contents (%s)': None,
 
39
        u'Bazaar User Guide': None,
 
40
        u'Bazaar User Reference': None,
 
41
        u'Bazaar Release Notes': None,
 
42
        u'Bazaar Upgrade Guide': None,
 
43
        u'Bazaar in five minutes': None,
 
44
        u'Bazaar Tutorial': None,
 
45
        u'Using Bazaar With Launchpad': None,
 
46
        u'Centralized Workflow Tutorial': None,
 
47
    }
 
48
 
 
49
# Helper function for looking up translations
 
50
def bzr_title(s):
 
51
    return bzr_titles.get(s) or s
 
52
 
29
53
 
30
54
# -- General configuration -----------------------------------------------------
31
55
 
60
84
 
61
85
# The language for content autogenerated by Sphinx. Refer to documentation
62
86
# for a list of supported languages.
63
 
#language = None
 
87
language = bzr_locale
64
88
 
65
89
# There are two options for replacing |today|: either, you set today to some
66
90
# non-false value, then it is used:
73
97
 
74
98
# List of directories, relative to source directory, that shouldn't be searched
75
99
# for source files.
76
 
exclude_trees = ['_build', 'ru', 'es', 'developers']
 
100
exclude_trees = ['_build']
77
101
 
78
102
# The reST default role (used for this markup: `text`) to use for all documents.
79
103
#default_role = None
132
156
#html_title = None
133
157
 
134
158
# A shorter title for the navigation bar.  Default is the same as html_title.
135
 
html_short_title = "Table of Contents (%s)" % (release,)
 
159
html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
136
160
 
137
161
# The name of an image file (relative to this directory) to place at the top
138
162
# of the sidebar.
184
208
#html_file_suffix = ''
185
209
 
186
210
# Output file base name for HTML help builder.
187
 
htmlhelp_basename = 'bzr-en-user-docs'
 
211
htmlhelp_basename = 'bzr-%s-user-docs' % (bzr_locale,)
188
212
 
189
213
 
190
214
# -- Options for LaTeX output --------------------------------------------------
199
223
# (source start file, target name, title, author, documentclass [howto/manual]).
200
224
latex_documents = [
201
225
  # Manuals
202
 
  ('en/user-guide/index', 'bzr-en-user-guide.tex', u'Bazaar User Guide',
203
 
   u'Bazaar Developers', 'manual'),
204
 
  ('en/user-reference/bzr_man', 'bzr-en-user-reference.tex', u'Bazaar User Reference',
205
 
   u'Bazaar Developers', 'manual'),
206
 
  ('en/release-notes/NEWS', 'bzr-en-release-notes.tex', u'Bazaar Release Notes',
207
 
   u'Bazaar Developers', 'manual'),
208
 
  ('en/upgrade-guide/index', 'bzr-en-upgrade-guide.tex', u'Bazaar Upgrade Guide',
209
 
   u'Bazaar Developers', 'manual'),
 
226
  ('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
 
227
    bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
 
228
  ('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
 
229
    bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
 
230
  ('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
 
231
    bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
 
232
  ('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
 
233
    bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
210
234
  # Tutorials
211
 
  ('en/mini-tutorial/index', 'bzr-en-tutorial-mini.tex', u'Bazaar in five minutes',
212
 
   u'Bazaar Developers', 'howto'),
213
 
  ('en/tutorials/tutorial', 'bzr-en-tutorial.tex', u'Bazaar Tutorial',
214
 
   u'Bazaar Developers', 'howto'),
215
 
  ('en/tutorials/using_bazaar_with_launchpad', 'bzr-en-tutorial-with-launchpad.tex',
216
 
   u'Using Bazaar With Launchpad', u'Bazaar Developers', 'howto'),
217
 
  ('en/tutorials/centralized_workflow', 'bzr-en-tutorial-centralized.tex',
218
 
   u'Centralized Workflow Tutorial', u'Bazaar Developers', 'howto'),
 
235
  ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
 
236
    bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
 
237
  ('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
 
238
    bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
 
239
  ('tutorials/using_bazaar_with_launchpad',
 
240
    'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
 
241
    bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
 
242
  ('tutorials/centralized_workflow',
 
243
    'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
 
244
    bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
219
245
]
220
246
 
221
247
# The name of an image file (relative to this directory) to place at the top of
222
248
# the title page.
223
 
latex_logo = 'Bazaar-Logo-For-Manuals.png'
 
249
latex_logo = '../Bazaar-Logo-For-Manuals.png'
224
250
 
225
251
# For "manual" documents, if this is true, then toplevel headings are parts,
226
252
# not chapters.