~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/conf.py

  • Committer: John Arbash Meinel
  • Date: 2009-07-31 17:42:29 UTC
  • mto: This revision was merged to the branch mainline in revision 4611.
  • Revision ID: john@arbash-meinel.com-20090731174229-w2zdsdlfpeddk8gl
Now we got to the per-workingtree tests, etc.

The main causes seem to break down into:
  bzrdir.clone() is known to be broken wrt locking, this effects
  everything that tries to 'push'

  shelf code is not compatible with strict locking

  merge code seems to have an issue. This might actually be the
  root cause of the clone() problems.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
5
5
#
6
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.
7
13
 
8
14
import sys, os
9
15
 
10
16
# If extensions (or modules to document with autodoc) are in another directory,
11
17
# add these directories to sys.path here. If the directory is relative to the
12
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
13
 
sys.path = [os.path.abspath('../..')] + sys.path
14
 
 
15
 
# Most of the configuration for Bazaar docs is defined here ...
16
 
from bzrlib.doc_generate.sphinx_conf import *
17
 
 
18
 
 
19
 
## Configuration specific to this site ##
20
 
 
21
 
# The locale code for this documentation set
22
 
bzr_locale = 'en'
23
 
 
24
 
# Translations & supporting helper function
25
 
bzr_titles = {
26
 
        u'Table of Contents (%s)': None,
27
 
        u'Bazaar User Guide': None,
28
 
        u'Bazaar User Reference': None,
29
 
        u'Bazaar Release Notes': None,
30
 
        u'Bazaar Upgrade Guide': None,
31
 
        u"Bazaar System Administrator's Guide": None,
32
 
        u'Bazaar in five minutes': None,
33
 
        u'Bazaar Tutorial': None,
34
 
        u'Using Bazaar With Launchpad': None,
35
 
        u'Centralized Workflow Tutorial': None,
36
 
        u"What's New in Bazaar 2.1?": None,
 
19
#sys.path.append(os.path.abspath('.'))
 
20
 
 
21
# -- General configuration -----------------------------------------------------
 
22
 
 
23
# Add any Sphinx extension module names here, as strings. They can be extensions
 
24
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 
25
extensions = ['sphinx.ext.ifconfig']
 
26
 
 
27
# Add any paths that contain templates here, relative to this directory.
 
28
templates_path = ['_templates']
 
29
 
 
30
# The suffix of source filenames.
 
31
source_suffix = '.txt'
 
32
 
 
33
# The encoding of source files.
 
34
#source_encoding = 'utf-8'
 
35
 
 
36
# The master toctree document.
 
37
master_doc = 'contents'
 
38
 
 
39
# General information about the project.
 
40
project = u'Bazaar'
 
41
copyright = u'2009, Canonical Ltd'
 
42
 
 
43
# The version info for the project you're documenting, acts as replacement for
 
44
# |version| and |release|, also used in various other places throughout the
 
45
# built documents.
 
46
#
 
47
# The short X.Y version.
 
48
version = '1.18'
 
49
# The full version, including alpha/beta/rc tags.
 
50
release = '1.18dev'
 
51
 
 
52
# The language for content autogenerated by Sphinx. Refer to documentation
 
53
# for a list of supported languages.
 
54
#language = None
 
55
 
 
56
# There are two options for replacing |today|: either, you set today to some
 
57
# non-false value, then it is used:
 
58
#today = ''
 
59
# Else, today_fmt is used as the format for a strftime call.
 
60
#today_fmt = '%B %d, %Y'
 
61
 
 
62
# List of documents that shouldn't be included in the build.
 
63
#unused_docs = []
 
64
 
 
65
# List of directories, relative to source directory, that shouldn't be searched
 
66
# for source files.
 
67
exclude_trees = ['_build']
 
68
 
 
69
# The reST default role (used for this markup: `text`) to use for all documents.
 
70
#default_role = None
 
71
 
 
72
# If true, '()' will be appended to :func: etc. cross-reference text.
 
73
#add_function_parentheses = True
 
74
 
 
75
# If true, the current module name will be prepended to all description
 
76
# unit titles (such as .. function::).
 
77
#add_module_names = True
 
78
 
 
79
# If true, sectionauthor and moduleauthor directives will be shown in the
 
80
# output. They are ignored by default.
 
81
#show_authors = False
 
82
 
 
83
# The name of the Pygments (syntax highlighting) style to use.
 
84
pygments_style = 'sphinx'
 
85
 
 
86
# A list of ignored prefixes for module index sorting.
 
87
#modindex_common_prefix = []
 
88
 
 
89
 
 
90
# -- Options for HTML output ---------------------------------------------------
 
91
 
 
92
# The theme to use for HTML and HTML Help pages.  Major themes that come with
 
93
# Sphinx are currently 'default' and 'sphinxdoc'.
 
94
html_theme = 'default'
 
95
 
 
96
# Theme options are theme-specific and customize the look and feel of a theme
 
97
# further.  For a list of options available for each theme, see the
 
98
# documentation.
 
99
html_theme_options = {
 
100
    'rightsidebar': True,
 
101
 
 
102
    # Non-document areas: header (relbar), footer, sidebar, etc.
 
103
    # Some useful colours here:
 
104
    # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
 
105
    #   midnightblue
 
106
    # * gray: dimgray, slategray, lightslategray
 
107
    'sidebarbgcolor':   "cornflowerblue",
 
108
    'sidebarlinkcolor': "midnightblue",
 
109
    'relbarbgcolor':    "darkblue",
 
110
    'footerbgcolor':    "lightslategray",
 
111
 
 
112
    # Text, heading and code colouring
 
113
    'codebgcolor':      "lightyellow",
 
114
    'codetextcolor':    "firebrick",
 
115
    'linkcolor':        "mediumblue",
37
116
    }
38
 
def bzr_title(s):
39
 
    return bzr_titles.get(s) or s
 
117
 
 
118
# Add any paths that contain custom themes here, relative to this directory.
 
119
#html_theme_path = []
 
120
 
 
121
# The name for this set of Sphinx documents.  If None, it defaults to
 
122
# "<project> v<release> documentation".
 
123
#html_title = None
40
124
 
41
125
# A shorter title for the navigation bar.  Default is the same as html_title.
42
 
html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
 
126
#html_short_title = None
 
127
 
 
128
# The name of an image file (relative to this directory) to place at the top
 
129
# of the sidebar.
 
130
#html_logo = None
 
131
 
 
132
# The name of an image file (within the static path) to use as favicon of the
 
133
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 
134
# pixels large.
 
135
html_favicon = "bzr.ico"
 
136
 
 
137
# Add any paths that contain custom static files (such as style sheets) here,
 
138
# relative to this directory. They are copied after the builtin static files,
 
139
# so a file named "default.css" will overwrite the builtin "default.css".
 
140
html_static_path = ['_static']
 
141
 
 
142
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 
143
# using the given strftime format.
 
144
#html_last_updated_fmt = '%b %d, %Y'
 
145
 
 
146
# If true, SmartyPants will be used to convert quotes and dashes to
 
147
# typographically correct entities.
 
148
#html_use_smartypants = True
 
149
 
 
150
# Custom sidebar templates, maps document names to template names.
 
151
#html_sidebars = {}
43
152
 
44
153
# Additional templates that should be rendered to pages, maps page names to
45
154
# template names.
46
 
html_additional_pages = {'index': 'index.html'}
 
155
html_additional_pages = {'contents': 'index.html'}
 
156
 
 
157
# If false, no module index is generated.
 
158
#html_use_modindex = True
 
159
 
 
160
# If false, no index is generated.
 
161
#html_use_index = True
 
162
 
 
163
# If true, the index is split into individual pages for each letter.
 
164
#html_split_index = False
 
165
 
 
166
# If true, links to the reST sources are added to the pages.
 
167
html_show_sourcelink = True
 
168
 
 
169
# If true, an OpenSearch description file will be output, and all pages will
 
170
# contain a <link> tag referring to it.  The value of this option must be the
 
171
# base URL from which the finished HTML is served.
 
172
#html_use_opensearch = ''
 
173
 
 
174
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 
175
#html_file_suffix = ''
47
176
 
48
177
# Output file base name for HTML help builder.
49
 
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
 
178
htmlhelp_basename = 'Bazaardoc'
 
179
 
 
180
 
 
181
# -- Options for LaTeX output --------------------------------------------------
 
182
 
 
183
# The paper size ('letter' or 'a4').
 
184
#latex_paper_size = 'letter'
 
185
 
 
186
# The font size ('10pt', '11pt' or '12pt').
 
187
#latex_font_size = '10pt'
50
188
 
51
189
# Grouping the document tree into LaTeX files. List of tuples
52
190
# (source start file, target name, title, author, documentclass [howto/manual]).
53
191
latex_documents = [
54
 
  # Manuals
55
 
  ('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
56
 
    bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
57
 
  ('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
58
 
    bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
59
 
  ('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
60
 
    bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
61
 
  ('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
62
 
    bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
63
 
  ('admin-guide/index', 'bzr-%s-admin-guide.tex' % (bzr_locale,),
64
 
    bzr_title(u"Bazaar System Administrator's Guide"), bzr_team, 'manual'),
65
 
  # Tutorials
66
 
  ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
67
 
    bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
68
 
  ('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
69
 
    bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
70
 
  ('tutorials/using_bazaar_with_launchpad',
71
 
    'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
72
 
    bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
73
 
  ('tutorials/centralized_workflow',
74
 
    'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
75
 
    bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
76
 
  ('whats-new/whats-new-in-2.1', 'bzr-%s-whats-new.tex' % (bzr_locale,),
77
 
    bzr_title(u"What's New in Bazaar 2.1?"), bzr_team, 'howto'),
78
 
]
79
 
 
80
 
# List of documents that shouldn't be included in the build.
81
 
unused_docs = [
82
 
    # Subtopics that get included
83
 
    'upgrade-guide/overview',
84
 
    'upgrade-guide/data_migration',
85
 
    'upgrade-guide/tips_and_tricks',
86
 
    # Plain-style documentation generation stuff
87
 
    'release-notes/NEWS',
88
 
    'user-reference/bzr_man',
89
 
    'user-guide/index-plain',
90
 
    'admin-guide/index-plain',
91
 
    # Miscellaneous
92
 
    'user-reference/readme',
93
 
]
94
 
 
 
192
  ('contents', 'Bazaar.tex', u'Bazaar Documentation',
 
193
   u'Bazaar Developers', 'manual'),
 
194
]
 
195
 
 
196
# The name of an image file (relative to this directory) to place at the top of
 
197
# the title page.
 
198
#latex_logo = None
 
199
 
 
200
# For "manual" documents, if this is true, then toplevel headings are parts,
 
201
# not chapters.
 
202
#latex_use_parts = False
 
203
 
 
204
# Additional stuff for the LaTeX preamble.
 
205
#latex_preamble = ''
 
206
 
 
207
# Documents to append as an appendix to all manuals.
 
208
#latex_appendices = []
 
209
 
 
210
# If false, no module index is generated.
 
211
#latex_use_modindex = True