← 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: 2009-10-13 06:08:53 UTC
  • mfrom: (4737.1.1 merge-2.0-into-devel)
  • Revision ID: pqm@pqm.ubuntu.com-20091013060853-erk2aaj80fnkrv25
(andrew) Merge lp:bzr/2.0 into lp:bzr, including fixes for #322807,
        #389413, #402623 and documentation improvements.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/conf.py
13
13
sys.path = [os.path.abspath('../..')] + sys.path
14
14
 
15
15
# Most of the configuration for Bazaar docs is defined here ...
16
 
from bzrlib.doc_generate.conf import *
 
16
from bzrlib.doc_generate.sphinx_conf import *
 
17
 
17
18
 
18
19
## Configuration specific to this site ##
19
20
 
27
28
        u'Bazaar User Reference': None,
28
29
        u'Bazaar Release Notes': None,
29
30
        u'Bazaar Upgrade Guide': None,
30
 
        u"Bazaar System Administrator's Guide": None,
31
31
        u'Bazaar in five minutes': None,
32
32
        u'Bazaar Tutorial': None,
33
33
        u'Using Bazaar With Launchpad': None,
34
34
        u'Centralized Workflow Tutorial': None,
35
 
        u"What's New in Bazaar 2.1?": None,
36
35
    }
37
36
def bzr_title(s):
38
37
    return bzr_titles.get(s) or s
47
46
# Output file base name for HTML help builder.
48
47
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
49
48
 
50
 
# Grouping the document tree into files. List of tuples
 
49
# Grouping the document tree into LaTeX files. List of tuples
51
50
# (source start file, target name, title, author, documentclass [howto/manual]).
52
 
bzr_documents = [
 
51
latex_documents = [
53
52
  # Manuals
54
 
  ('user-guide/index', 'bzr-%s-user-guide' % (bzr_locale,),
 
53
  ('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
55
54
    bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
56
 
  ('user-reference/index', 'bzr-%s-user-reference' % (bzr_locale,),
 
55
  ('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
57
56
    bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
58
 
  ('release-notes/index', 'bzr-%s-release-notes' % (bzr_locale,),
 
57
  ('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
59
58
    bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
60
 
  ('upgrade-guide/index', 'bzr-%s-upgrade-guide' % (bzr_locale,),
 
59
  ('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
61
60
    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
61
  # Tutorials
65
 
  ('mini-tutorial/index', 'bzr-%s-tutorial-mini' % (bzr_locale,),
 
62
  ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
66
63
    bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
67
 
  ('tutorials/tutorial', 'bzr-%s-tutorial' % (bzr_locale,),
 
64
  ('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
68
65
    bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
69
66
  ('tutorials/using_bazaar_with_launchpad',
70
 
    'bzr-%s-tutorial-with-launchpad' % (bzr_locale,),
 
67
    'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
71
68
    bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
72
69
  ('tutorials/centralized_workflow',
73
 
    'bzr-%s-tutorial-centralized' % (bzr_locale,),
 
70
    'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
74
71
    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
72
]
78
73
 
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
74
# List of documents that shouldn't be included in the build.
90
75
unused_docs = [
 
76
    # Placeholder for later
 
77
    'admin-guide/index',
91
78
    # Subtopics that get included
92
79
    'upgrade-guide/overview',
93
80
    'upgrade-guide/data_migration',
96
83
    'release-notes/NEWS',
97
84
    'user-reference/bzr_man',
98
85
    'user-guide/index-plain',
99
 
    'admin-guide/index-plain',
100
 
    # Templates
101
 
    'release-notes/release-template',
102
 
    'release-notes/series-template',
103
86
    # Miscellaneous
104
87
    'user-reference/readme',
105
88
]