~bzr-pqm/bzr/bzr.dev

4557.3.1 by Ian Clatworthy
Core website & navigation working
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.
4634.39.26 by Ian Clatworthy
moce most of the sphinx configuration settings into a central place
13
sys.path = [os.path.abspath('../..')] + sys.path
14
15
# Most of the configuration for Bazaar docs is defined here ...
5193.6.4 by Vincent Ladeuil
Test that the sphinx texinfo extension is loaded.
16
from bzrlib.doc_generate.conf import *
4634.39.26 by Ian Clatworthy
moce most of the sphinx configuration settings into a central place
17
18
## Configuration specific to this site ##
4634.39.7 by Ian Clatworthy
take Russian and Spanish docs out of the English website/chm file
19
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
20
# The locale code for this documentation set
21
bzr_locale = 'en'
22
4634.39.26 by Ian Clatworthy
moce most of the sphinx configuration settings into a central place
23
# Translations & supporting helper function
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
24
bzr_titles = {
25
        u'Table of Contents (%s)': None,
26
        u'Bazaar User Guide': None,
27
        u'Bazaar User Reference': None,
28
        u'Bazaar Release Notes': None,
29
        u'Bazaar Upgrade Guide': None,
4797.30.2 by Ian Clatworthy
Add System Admin Guide to the PDF set too
30
        u"Bazaar System Administrator's Guide": None,
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
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,
4797.30.1 by Ian Clatworthy
add What's New to the list of PDF documents generated
35
        u"What's New in Bazaar 2.1?": None,
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
36
    }
37
def bzr_title(s):
38
    return bzr_titles.get(s) or s
39
4557.3.1 by Ian Clatworthy
Core website & navigation working
40
# A shorter title for the navigation bar.  Default is the same as html_title.
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
41
html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
4557.3.1 by Ian Clatworthy
Core website & navigation working
42
43
# Additional templates that should be rendered to pages, maps page names to
44
# template names.
4634.38.2 by Ian Clatworthy
Improvements to html in preparation for better chm
45
html_additional_pages = {'index': 'index.html'}
4557.3.1 by Ian Clatworthy
Core website & navigation working
46
47
# Output file base name for HTML help builder.
4634.39.30 by Ian Clatworthy
tweak chm file naming
48
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
4557.3.1 by Ian Clatworthy
Core website & navigation working
49
50
# Grouping the document tree into LaTeX files. List of tuples
51
# (source start file, target name, title, author, documentclass [howto/manual]).
52
latex_documents = [
4634.38.1 by Ian Clatworthy
first cut at pdf docs via sphinx
53
  # Manuals
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
54
  ('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
55
    bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
5255.1.1 by Ian Clatworthy
Fix PDF generation of User Reference
56
  ('user-reference/index', 'bzr-%s-user-reference.tex' % (bzr_locale,),
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
57
    bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
5462.5.8 by Andrew Bennetts
Tweaks to the sphinx build.
58
  ('release-notes/index', 'bzr-%s-release-notes.tex' % (bzr_locale,),
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
59
    bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
60
  ('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
61
    bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
4797.30.2 by Ian Clatworthy
Add System Admin Guide to the PDF set too
62
  ('admin-guide/index', 'bzr-%s-admin-guide.tex' % (bzr_locale,),
63
    bzr_title(u"Bazaar System Administrator's Guide"), bzr_team, 'manual'),
4634.38.1 by Ian Clatworthy
first cut at pdf docs via sphinx
64
  # Tutorials
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
65
  ('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
66
    bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
67
  ('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
68
    bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
69
  ('tutorials/using_bazaar_with_launchpad',
70
    'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
71
    bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
72
  ('tutorials/centralized_workflow',
73
    'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
74
    bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
4797.30.1 by Ian Clatworthy
add What's New to the list of PDF documents generated
75
  ('whats-new/whats-new-in-2.1', 'bzr-%s-whats-new.tex' % (bzr_locale,),
76
    bzr_title(u"What's New in Bazaar 2.1?"), bzr_team, 'howto'),
4557.3.1 by Ian Clatworthy
Core website & navigation working
77
]
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
78
79
# List of documents that shouldn't be included in the build.
80
unused_docs = [
4634.39.38 by Ian Clatworthy
make sure the special topics used in plain-style are ignored when building the English user docs under sphinx
81
    # Subtopics that get included
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
82
    'upgrade-guide/overview',
83
    'upgrade-guide/data_migration',
84
    'upgrade-guide/tips_and_tricks',
4634.39.38 by Ian Clatworthy
make sure the special topics used in plain-style are ignored when building the English user docs under sphinx
85
    # Plain-style documentation generation stuff
86
    'release-notes/NEWS',
87
    'user-reference/bzr_man',
88
    'user-guide/index-plain',
4871.6.2 by Neil Martinsen-Burrell
tweaks based on JAMs review
89
    'admin-guide/index-plain',
5462.5.8 by Andrew Bennetts
Tweaks to the sphinx build.
90
    # Templates
91
    'release-notes/release-template',
92
    'release-notes/series-template',
4634.39.38 by Ian Clatworthy
make sure the special topics used in plain-style are ignored when building the English user docs under sphinx
93
    # Miscellaneous
94
    'user-reference/readme',
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
95
]
96