← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/conf.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-03-28 06:58:22 UTC
  • mfrom: (2379.2.3 hpss-chroot)
  • Revision ID: pqm@pqm.ubuntu.com-20070328065822-999550a858a3ced3
(robertc) Fix chroot urls to not expose the url of the transport they are protecting, allowing regular url operations to work on them. (Robert Collins, Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/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
 
import sys, os
9
 
 
10
 
# If extensions (or modules to document with autodoc) are in another directory,
11
 
# add these directories to sys.path here. If the directory is relative to the
12
 
# 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.conf import *
17
 
 
18
 
## Configuration specific to this site ##
19
 
 
20
 
# The locale code for this documentation set
21
 
bzr_locale = 'en'
22
 
 
23
 
# Translations & supporting helper function
24
 
bzr_titles = {
25
 
        u'Table of Contents (%s)': None,
26
 
        u'Bazaar User Guide': None,
27
 
        u'Bazaar User Reference': None,
28
 
        u'Bazaar Release Notes': None,
29
 
        u'Bazaar Upgrade Guide': None,
30
 
        u"Bazaar System Administrator's Guide": None,
31
 
        u'Bazaar in five minutes': None,
32
 
        u'Bazaar Tutorial': None,
33
 
        u'Using Bazaar With Launchpad': None,
34
 
        u'Centralized Workflow Tutorial': None,
35
 
        u"What's New in Bazaar 2.1?": None,
36
 
    }
37
 
def bzr_title(s):
38
 
    return bzr_titles.get(s) or s
39
 
 
40
 
# A shorter title for the navigation bar.  Default is the same as html_title.
41
 
html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
42
 
 
43
 
# Additional templates that should be rendered to pages, maps page names to
44
 
# template names.
45
 
html_additional_pages = {'index': 'index.html'}
46
 
 
47
 
# Output file base name for HTML help builder.
48
 
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
49
 
 
50
 
# Grouping the document tree into files. List of tuples
51
 
# (source start file, target name, title, author, documentclass [howto/manual]).
52
 
bzr_documents = [
53
 
  # Manuals
54
 
  ('user-guide/index', 'bzr-%s-user-guide' % (bzr_locale,),
55
 
    bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
56
 
  ('user-reference/index', 'bzr-%s-user-reference' % (bzr_locale,),
57
 
    bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
58
 
  ('release-notes/index', 'bzr-%s-release-notes' % (bzr_locale,),
59
 
    bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
60
 
  ('upgrade-guide/index', 'bzr-%s-upgrade-guide' % (bzr_locale,),
61
 
    bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
62
 
  ('admin-guide/index', 'bzr-%s-admin-guide' % (bzr_locale,),
63
 
    bzr_title(u"Bazaar System Administrator's Guide"), bzr_team, 'manual'),
64
 
  # Tutorials
65
 
  ('mini-tutorial/index', 'bzr-%s-tutorial-mini' % (bzr_locale,),
66
 
    bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
67
 
  ('tutorials/tutorial', 'bzr-%s-tutorial' % (bzr_locale,),
68
 
    bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
69
 
  ('tutorials/using_bazaar_with_launchpad',
70
 
    'bzr-%s-tutorial-with-launchpad' % (bzr_locale,),
71
 
    bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
72
 
  ('tutorials/centralized_workflow',
73
 
    'bzr-%s-tutorial-centralized' % (bzr_locale,),
74
 
    bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
75
 
  ('whats-new/whats-new-in-2.1', 'bzr-%s-whats-new' % (bzr_locale,),
76
 
    bzr_title(u"What's New in Bazaar 2.1?"), bzr_team, 'howto'),
77
 
]
78
 
 
79
 
latex_documents = [
80
 
    (start, target+'.tex', title, author, doc_class)
81
 
    for start, target, title, author, doc_class in bzr_documents
82
 
    ]
83
 
 
84
 
texinfo_documents = [
85
 
    (start, target, title, author, doc_class)
86
 
    for start, target, title, author, doc_class in bzr_documents
87
 
    ]
88
 
 
89
 
# List of documents that shouldn't be included in the build.
90
 
unused_docs = [
91
 
    # Subtopics that get included
92
 
    'upgrade-guide/overview',
93
 
    'upgrade-guide/data_migration',
94
 
    'upgrade-guide/tips_and_tricks',
95
 
    # Plain-style documentation generation stuff
96
 
    'release-notes/NEWS',
97
 
    'user-reference/bzr_man',
98
 
    'user-guide/index-plain',
99
 
    'admin-guide/index-plain',
100
 
    # Templates
101
 
    'release-notes/release-template',
102
 
    'release-notes/series-template',
103
 
    # Miscellaneous
104
 
    'user-reference/readme',
105
 
]
106