← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/conf.py

  • Committer: Martin Pool
  • Date: 2005-05-05 07:00:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050505070017-6af6a766fc558dc2
todo

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/conf.py
1
 
# -*- coding: utf-8 -*-
2
 
#
3
 
# Bazaar 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 Bazaar docs is defined here ...
16
 
from bzrlib.doc_generate.sphinx_conf import *
17
 
 
18
 
 
19
 
## Configuration specific to this site ##
20
 
 
21
 
# The locale code for this documentation set
22
 
bzr_locale = 'en'
23
 
 
24
 
# 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 in five minutes': None,
32
 
        u'Bazaar Tutorial': None,
33
 
        u'Using Bazaar With Launchpad': None,
34
 
        u'Centralized Workflow Tutorial': None,
35
 
    }
36
 
def bzr_title(s):
37
 
    return bzr_titles.get(s) or s
38
 
 
39
 
# A shorter title for the navigation bar.  Default is the same as html_title.
40
 
html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
41
 
 
42
 
# Additional templates that should be rendered to pages, maps page names to
43
 
# template names.
44
 
html_additional_pages = {'index': 'index.html'}
45
 
 
46
 
# Output file base name for HTML help builder.
47
 
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
48
 
 
49
 
# Grouping the document tree into LaTeX files. List of tuples
50
 
# (source start file, target name, title, author, documentclass [howto/manual]).
51
 
latex_documents = [
52
 
  # Manuals
53
 
  ('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
54
 
    bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
55
 
  ('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
56
 
    bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
57
 
  ('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
58
 
    bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
59
 
  ('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
60
 
    bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
61
 
  # Tutorials
62
 
  ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
63
 
    bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
64
 
  ('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
65
 
    bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
66
 
  ('tutorials/using_bazaar_with_launchpad',
67
 
    'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
68
 
    bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
69
 
  ('tutorials/centralized_workflow',
70
 
    'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
71
 
    bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
72
 
]
73
 
 
74
 
# List of documents that shouldn't be included in the build.
75
 
unused_docs = [
76
 
    # Subtopics that get included
77
 
    'upgrade-guide/overview',
78
 
    'upgrade-guide/data_migration',
79
 
    'upgrade-guide/tips_and_tricks',
80
 
    # Plain-style documentation generation stuff
81
 
    'release-notes/NEWS',
82
 
    'user-reference/bzr_man',
83
 
    'user-guide/index-plain',
84
 
    'admin-guide/index-plain',
85
 
    # Miscellaneous
86
 
    'user-reference/readme',
87
 
]
88