← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/es/conf.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-07 03:58:08 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-20090907035808-v683ok0q3hrt4d11
move Spanish doc into it's own website/chm file

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/es/conf.py
 
1
# -*- coding: utf-8 -*-
 
2
#
 
3
# Bazaar documentation build configuration file, created by
 
4
# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
 
5
#
 
6
# This file is execfile()d with the current directory set to its containing dir.
 
7
#
 
8
# Note that not all possible configuration values are present in this
 
9
# autogenerated file.
 
10
#
 
11
# All configuration values have a default; values that are commented out
 
12
# serve to show the default.
 
13
 
 
14
import sys, os
 
15
 
 
16
# If extensions (or modules to document with autodoc) are in another directory,
 
17
# add these directories to sys.path here. If the directory is relative to the
 
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
 
19
#sys.path.append(os.path.abspath('.'))
 
20
 
 
21
 
 
22
# -- Bazaar-specific configuration ---------------------------------------------
 
23
 
 
24
# NOTE: Editing this section is generally all that is required ...
 
25
 
 
26
# We *could* get this from bzrlib but there's no certainly that the bzr on
 
27
# the Python path is indeed the one we're building the documentation for ...
 
28
bzr_version = (2, 0, 0, 'rc', 2)
 
29
 
 
30
# The locale code for this documentation set
 
31
bzr_locale = 'es'
 
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
 
 
53
 
 
54
# -- General configuration -----------------------------------------------------
 
55
 
 
56
# Add any Sphinx extension module names here, as strings. They can be extensions
 
57
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 
58
extensions = ['sphinx.ext.ifconfig']
 
59
 
 
60
# Add any paths that contain templates here, relative to this directory.
 
61
templates_path = ['_templates']
 
62
 
 
63
# The suffix of source filenames.
 
64
source_suffix = '.txt'
 
65
 
 
66
# The encoding of source files.
 
67
#source_encoding = 'utf-8'
 
68
 
 
69
# The master toctree document.
 
70
master_doc = 'index'
 
71
 
 
72
# General information about the project.
 
73
project = u'Bazaar'
 
74
copyright = u'2009, Canonical Ltd'
 
75
 
 
76
# The version info for the project you're documenting, acts as replacement for
 
77
# |version| and |release|, also used in various other places throughout the
 
78
# built documents.
 
79
#
 
80
# The short X.Y version.
 
81
version = '.'.join(str(p) for p in bzr_version[:3])
 
82
# The full version, including alpha/beta/rc tags.
 
83
release = version + ''.join(str(p) for p in bzr_version[3:])
 
84
 
 
85
# The language for content autogenerated by Sphinx. Refer to documentation
 
86
# for a list of supported languages.
 
87
language = bzr_locale
 
88
 
 
89
# There are two options for replacing |today|: either, you set today to some
 
90
# non-false value, then it is used:
 
91
#today = ''
 
92
# Else, today_fmt is used as the format for a strftime call.
 
93
#today_fmt = '%B %d, %Y'
 
94
 
 
95
# List of documents that shouldn't be included in the build.
 
96
#unused_docs = []
 
97
 
 
98
# List of directories, relative to source directory, that shouldn't be searched
 
99
# for source files.
 
100
exclude_trees = ['_build']
 
101
 
 
102
# The reST default role (used for this markup: `text`) to use for all documents.
 
103
#default_role = None
 
104
 
 
105
# If true, '()' will be appended to :func: etc. cross-reference text.
 
106
#add_function_parentheses = True
 
107
 
 
108
# If true, the current module name will be prepended to all description
 
109
# unit titles (such as .. function::).
 
110
#add_module_names = True
 
111
 
 
112
# If true, sectionauthor and moduleauthor directives will be shown in the
 
113
# output. They are ignored by default.
 
114
#show_authors = False
 
115
 
 
116
# The name of the Pygments (syntax highlighting) style to use.
 
117
pygments_style = 'sphinx'
 
118
 
 
119
# A list of ignored prefixes for module index sorting.
 
120
#modindex_common_prefix = []
 
121
 
 
122
 
 
123
# -- Options for HTML output ---------------------------------------------------
 
124
 
 
125
# The theme to use for HTML and HTML Help pages.  Major themes that come with
 
126
# Sphinx are currently 'default' and 'sphinxdoc'.
 
127
html_theme = 'default'
 
128
 
 
129
# Theme options are theme-specific and customize the look and feel of a theme
 
130
# further.  For a list of options available for each theme, see the
 
131
# documentation.
 
132
html_theme_options = {
 
133
    'rightsidebar': True,
 
134
 
 
135
    # Non-document areas: header (relbar), footer, sidebar, etc.
 
136
    # Some useful colours here:
 
137
    # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
 
138
    #   midnightblue
 
139
    # * gray: dimgray, slategray, lightslategray
 
140
    'sidebarbgcolor':   "cornflowerblue",
 
141
    'sidebarlinkcolor': "midnightblue",
 
142
    'relbarbgcolor':    "darkblue",
 
143
    'footerbgcolor':    "lightslategray",
 
144
 
 
145
    # Text, heading and code colouring
 
146
    'codebgcolor':      "lightyellow",
 
147
    'codetextcolor':    "firebrick",
 
148
    'linkcolor':        "mediumblue",
 
149
    }
 
150
 
 
151
# Add any paths that contain custom themes here, relative to this directory.
 
152
#html_theme_path = []
 
153
 
 
154
# The name for this set of Sphinx documents.  If None, it defaults to
 
155
# "<project> v<release> documentation".
 
156
#html_title = None
 
157
 
 
158
# A shorter title for the navigation bar.  Default is the same as html_title.
 
159
html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
 
160
 
 
161
# The name of an image file (relative to this directory) to place at the top
 
162
# of the sidebar.
 
163
#html_logo = None
 
164
 
 
165
# The name of an image file (within the static path) to use as favicon of the
 
166
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 
167
# pixels large.
 
168
html_favicon = "bzr.ico"
 
169
 
 
170
# Add any paths that contain custom static files (such as style sheets) here,
 
171
# relative to this directory. They are copied after the builtin static files,
 
172
# so a file named "default.css" will overwrite the builtin "default.css".
 
173
html_static_path = ['_static']
 
174
 
 
175
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 
176
# using the given strftime format.
 
177
#html_last_updated_fmt = '%b %d, %Y'
 
178
 
 
179
# If true, SmartyPants will be used to convert quotes and dashes to
 
180
# typographically correct entities.
 
181
#html_use_smartypants = True
 
182
 
 
183
# Custom sidebar templates, maps document names to template names.
 
184
#html_sidebars = {}
 
185
 
 
186
# Additional templates that should be rendered to pages, maps page names to
 
187
# template names.
 
188
#html_additional_pages = {'index': 'index.html'}
 
189
 
 
190
# If false, no module index is generated.
 
191
html_use_modindex = False
 
192
 
 
193
# If false, no index is generated.
 
194
html_use_index = False
 
195
 
 
196
# If true, the index is split into individual pages for each letter.
 
197
#html_split_index = False
 
198
 
 
199
# If true, links to the reST sources are added to the pages.
 
200
html_show_sourcelink = True
 
201
 
 
202
# If true, an OpenSearch description file will be output, and all pages will
 
203
# contain a <link> tag referring to it.  The value of this option must be the
 
204
# base URL from which the finished HTML is served.
 
205
#html_use_opensearch = ''
 
206
 
 
207
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 
208
#html_file_suffix = ''
 
209
 
 
210
# Output file base name for HTML help builder.
 
211
htmlhelp_basename = 'bzr-%s-user-docs' % (bzr_locale,)
 
212
 
 
213
 
 
214
# -- Options for LaTeX output --------------------------------------------------
 
215
 
 
216
# The paper size ('letter' or 'a4').
 
217
#latex_paper_size = 'letter'
 
218
 
 
219
# The font size ('10pt', '11pt' or '12pt').
 
220
#latex_font_size = '10pt'
 
221
 
 
222
# Grouping the document tree into LaTeX files. List of tuples
 
223
# (source start file, target name, title, author, documentclass [howto/manual]).
 
224
latex_documents = [
 
225
  # Manuals
 
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'),
 
234
  # Tutorials
 
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'),
 
245
]
 
246
 
 
247
# The name of an image file (relative to this directory) to place at the top of
 
248
# the title page.
 
249
latex_logo = 'Bazaar-Logo-For-Manuals.png'
 
250
 
 
251
# For "manual" documents, if this is true, then toplevel headings are parts,
 
252
# not chapters.
 
253
#latex_use_parts = False
 
254
 
 
255
# Additional stuff for the LaTeX preamble.
 
256
#latex_preamble = ''
 
257
 
 
258
# Documents to append as an appendix to all manuals.
 
259
#latex_appendices = []
 
260
 
 
261
# If false, no module index is generated.
 
262
#latex_use_modindex = True