/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: Jelmer Vernooij
  • Date: 2020-04-05 19:11:34 UTC
  • mto: (7490.7.16 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200405191134-0aebh8ikiwygxma5
Populate the .gitignore file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/conf.py
1
1
# -*- coding: utf-8 -*-
2
2
#
3
 
# Bazaar documentation build configuration file, created by
 
3
# Breezy 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 Bazaar docs is defined here ...
16
 
from bzrlib.doc_generate.sphinx_conf import *
17
 
 
 
15
# Most of the configuration for Breezy docs is defined here ...
 
16
from breezy.doc_generate.conf import *
18
17
 
19
18
## Configuration specific to this site ##
20
19
 
21
20
# The locale code for this documentation set
22
 
bzr_locale = 'en'
 
21
brz_locale = 'en'
23
22
 
24
23
# 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,
 
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,
37
36
    }
38
 
def bzr_title(s):
39
 
    return bzr_titles.get(s) or s
 
37
def brz_title(s):
 
38
    return brz_titles.get(s) or s
40
39
 
41
40
# 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,)
 
41
html_short_title = brz_title(u"Table of Contents (%s)") % (release,)
43
42
 
44
43
# Additional templates that should be rendered to pages, maps page names to
45
44
# template names.
46
45
html_additional_pages = {'index': 'index.html'}
47
46
 
48
47
# Output file base name for HTML help builder.
49
 
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
 
48
htmlhelp_basename = 'brz-%s' % (brz_locale,)
50
49
 
51
 
# Grouping the document tree into LaTeX files. List of tuples
 
50
# Grouping the document tree into files. List of tuples
52
51
# (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
 
53
82
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
 
]
 
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
    ]
79
91
 
80
92
# List of documents that shouldn't be included in the build.
81
93
unused_docs = [
85
97
    'upgrade-guide/tips_and_tricks',
86
98
    # Plain-style documentation generation stuff
87
99
    'release-notes/NEWS',
88
 
    'user-reference/bzr_man',
 
100
    'user-reference/brz_man',
89
101
    'user-guide/index-plain',
90
102
    'admin-guide/index-plain',
 
103
    # Templates
 
104
    'release-notes/release-template',
 
105
    'release-notes/series-template',
91
106
    # Miscellaneous
92
107
    'user-reference/readme',
93
108
]
94