← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/conf.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

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