/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/en/conf.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/conf.py
1
1
# -*- coding: utf-8 -*-
2
2
#
3
 
# Breezy documentation build configuration file, created by
 
3
# Bazaar documentation build configuration file, created by
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.
12
12
# documentation root, use os.path.abspath to make it absolute, like shown here.
13
13
sys.path = [os.path.abspath('../..')] + sys.path
14
14
 
15
 
# Most of the configuration for Breezy docs is defined here ...
16
 
from breezy.doc_generate.conf import *
 
15
# Most of the configuration for Bazaar docs is defined here ...
 
16
from bzrlib.doc_generate.sphinx_conf import *
 
17
 
17
18
 
18
19
## Configuration specific to this site ##
19
20
 
20
21
# The locale code for this documentation set
21
 
brz_locale = 'en'
 
22
bzr_locale = 'en'
22
23
 
23
24
# Translations & supporting helper function
24
 
brz_titles = {
25
 
    u'Table of Contents (%s)': None,
26
 
    u'Breezy User Guide': None,
27
 
    u'Breezy User Reference': None,
28
 
    u'Breezy Release Notes': None,
29
 
    u'Breezy Upgrade Guide': None,
30
 
    u"Breezy System Administrator's Guide": None,
31
 
    u'Breezy in five minutes': None,
32
 
    u'Breezy Tutorial': None,
33
 
    u'Using Breezy With Launchpad': None,
34
 
    u'Centralized Workflow Tutorial': None,
35
 
    u"What's New in Breezy 2.1?": None,
 
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,
36
37
    }
37
 
def brz_title(s):
38
 
    return brz_titles.get(s) or s
 
38
def bzr_title(s):
 
39
    return bzr_titles.get(s) or s
39
40
 
40
41
# A shorter title for the navigation bar.  Default is the same as html_title.
41
 
html_short_title = brz_title(u"Table of Contents (%s)") % (release,)
 
42
html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
42
43
 
43
44
# Additional templates that should be rendered to pages, maps page names to
44
45
# template names.
45
46
html_additional_pages = {'index': 'index.html'}
46
47
 
47
48
# Output file base name for HTML help builder.
48
 
htmlhelp_basename = 'brz-%s' % (brz_locale,)
 
49
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
49
50
 
50
 
# Grouping the document tree into files. List of tuples
 
51
# Grouping the document tree into LaTeX files. List of tuples
51
52
# (source start file, target name, title, author, documentclass [howto/manual]).
52
 
brz_documents = [
53
 
    # Manuals
54
 
    ('user-guide/index', 'brz-%s-user-guide' % (brz_locale,),
55
 
     brz_title(u'Breezy User Guide'), brz_team, 'manual'),
56
 
    ('user-reference/index', 'brz-%s-user-reference' % (brz_locale,),
57
 
     brz_title(u'Breezy User Reference'), brz_team, 'manual'),
58
 
    ('release-notes/index', 'brz-%s-release-notes' % (brz_locale,),
59
 
     brz_title(u'Breezy Release Notes'), brz_team, 'manual'),
60
 
    ('upgrade-guide/index', 'brz-%s-upgrade-guide' % (brz_locale,),
61
 
     brz_title(u'Breezy Upgrade Guide'), brz_team, 'manual'),
62
 
    ('admin-guide/index', 'brz-%s-admin-guide' % (brz_locale,),
63
 
     brz_title(u"Breezy System Administrator's Guide"), brz_team, 'manual'),
64
 
    # Tutorials
65
 
    ('mini-tutorial/index', 'brz-%s-tutorial-mini' % (brz_locale,),
66
 
     brz_title(u'Breezy in five minutes'), brz_team, 'howto'),
67
 
    ('tutorials/tutorial', 'brz-%s-tutorial' % (brz_locale,),
68
 
     brz_title(u'Breezy Tutorial'), brz_team, 'howto'),
69
 
    ('tutorials/using_breezy_with_github',
70
 
     'brz-%s-tutorial-with-github' % (brz_locale,),
71
 
     brz_title(u'Using Breezy With GitHub'), brz_team, 'howto'),
72
 
    ('tutorials/using_breezy_with_launchpad',
73
 
     'brz-%s-tutorial-with-launchpad' % (brz_locale,),
74
 
     brz_title(u'Using Breezy With Launchpad'), brz_team, 'howto'),
75
 
    ('tutorials/centralized_workflow',
76
 
     'brz-%s-tutorial-centralized' % (brz_locale,),
77
 
     brz_title(u'Centralized Workflow Tutorial'), brz_team, 'howto'),
78
 
    ('whats-new/whats-new-in-3.0', 'brz-%s-whats-new' % (brz_locale,),
79
 
     brz_title(u"What's New in Breezy 3.0?"), brz_team, 'howto'),
80
 
]
81
 
 
82
53
latex_documents = [
83
 
    (start, target + '.tex', title, author, doc_class)
84
 
    for start, target, title, author, doc_class in brz_documents
85
 
    ]
86
 
 
87
 
texinfo_documents = [
88
 
    (start, target, title, author, doc_class)
89
 
    for start, target, title, author, doc_class in brz_documents
90
 
    ]
 
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/index', '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
]
91
79
 
92
80
# List of documents that shouldn't be included in the build.
93
81
unused_docs = [
97
85
    'upgrade-guide/tips_and_tricks',
98
86
    # Plain-style documentation generation stuff
99
87
    'release-notes/NEWS',
100
 
    'user-reference/brz_man',
 
88
    'user-reference/bzr_man',
101
89
    'user-guide/index-plain',
102
90
    'admin-guide/index-plain',
103
 
    # Templates
104
 
    'release-notes/release-template',
105
 
    'release-notes/series-template',
106
91
    # Miscellaneous
107
92
    'user-reference/readme',
108
93
]
 
94