/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: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/conf.py
1
 
# -*- coding: utf-8 -*-
2
 
#
3
 
# Breezy 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 Breezy docs is defined here ...
16
 
from breezy.doc_generate.conf import *
17
 
 
18
 
## Configuration specific to this site ##
19
 
 
20
 
# The locale code for this documentation set
21
 
brz_locale = 'en'
22
 
 
23
 
# 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,
36
 
    }
37
 
def brz_title(s):
38
 
    return brz_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 = brz_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 = 'brz-%s' % (brz_locale,)
49
 
 
50
 
# Grouping the document tree into files. List of tuples
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.1', 'brz-%s-whats-new' % (brz_locale,),
79
 
     brz_title(u"What's New in Breezy 3.1?"), brz_team, 'howto'),
80
 
]
81
 
 
82
 
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
 
    ]
91
 
 
92
 
# List of documents that shouldn't be included in the build.
93
 
unused_docs = [
94
 
    # Subtopics that get included
95
 
    'upgrade-guide/overview',
96
 
    'upgrade-guide/data_migration',
97
 
    'upgrade-guide/tips_and_tricks',
98
 
    # Plain-style documentation generation stuff
99
 
    'release-notes/NEWS',
100
 
    'user-reference/brz_man',
101
 
    'user-guide/index-plain',
102
 
    'admin-guide/index-plain',
103
 
    # Templates
104
 
    'release-notes/release-template',
105
 
    'release-notes/series-template',
106
 
    # Miscellaneous
107
 
    'user-reference/readme',
108
 
]