/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
4557.3.1 by Ian Clatworthy
Core website & navigation working
1
# -*- coding: utf-8 -*-
2
#
6622.1.23 by Jelmer Vernooij
More renames in English docs.
3
# Breezy documentation build configuration file, created by
4557.3.1 by Ian Clatworthy
Core website & navigation working
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
6622.1.23 by Jelmer Vernooij
More renames in English docs.
15
# Most of the configuration for Breezy docs is defined here ...
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
16
from breezy.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
6622.1.23 by Jelmer Vernooij
More renames in English docs.
21
brz_locale = 'en'
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
22
4634.39.26 by Ian Clatworthy
moce most of the sphinx configuration settings into a central place
23
# Translations & supporting helper function
6622.1.23 by Jelmer Vernooij
More renames in English docs.
24
brz_titles = {
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
25
        u'Table of Contents (%s)': None,
6622.1.23 by Jelmer Vernooij
More renames in English docs.
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,
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
34
        u'Centralized Workflow Tutorial': None,
6622.1.23 by Jelmer Vernooij
More renames in English docs.
35
        u"What's New in Breezy 2.1?": None,
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
36
    }
6622.1.23 by Jelmer Vernooij
More renames in English docs.
37
def brz_title(s):
38
    return brz_titles.get(s) or s
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
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.
6622.1.23 by Jelmer Vernooij
More renames in English docs.
41
html_short_title = brz_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.
6622.1.23 by Jelmer Vernooij
More renames in English docs.
48
htmlhelp_basename = 'brz-%s' % (brz_locale,)
4557.3.1 by Ian Clatworthy
Core website & navigation working
49
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
50
# Grouping the document tree into files. List of tuples
4557.3.1 by Ian Clatworthy
Core website & navigation working
51
# (source start file, target name, title, author, documentclass [howto/manual]).
6622.1.23 by Jelmer Vernooij
More renames in English docs.
52
brz_documents = [
4634.38.1 by Ian Clatworthy
first cut at pdf docs via sphinx
53
  # Manuals
6622.1.23 by Jelmer Vernooij
More renames in English docs.
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'),
4634.38.1 by Ian Clatworthy
first cut at pdf docs via sphinx
64
  # Tutorials
6622.1.23 by Jelmer Vernooij
More renames in English docs.
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_launchpad',
70
    'brz-%s-tutorial-with-launchpad' % (brz_locale,),
71
    brz_title(u'Using Breezy With Launchpad'), brz_team, 'howto'),
4634.39.18 by Ian Clatworthy
build the English user docs just like the other languages
72
  ('tutorials/centralized_workflow',
6622.1.23 by Jelmer Vernooij
More renames in English docs.
73
    'brz-%s-tutorial-centralized' % (brz_locale,),
74
    brz_title(u'Centralized Workflow Tutorial'), brz_team, 'howto'),
75
  ('whats-new/whats-new-in-2.1', 'brz-%s-whats-new' % (brz_locale,),
76
    brz_title(u"What's New in Breezy 2.1?"), brz_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
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
79
latex_documents = [
80
    (start, target+'.tex', title, author, doc_class)
6622.1.23 by Jelmer Vernooij
More renames in English docs.
81
    for start, target, title, author, doc_class in brz_documents
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
82
    ]
83
84
texinfo_documents = [
85
    (start, target, title, author, doc_class)
6622.1.23 by Jelmer Vernooij
More renames in English docs.
86
    for start, target, title, author, doc_class in brz_documents
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
87
    ]
88
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
89
# List of documents that shouldn't be included in the build.
90
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
91
    # Subtopics that get included
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
92
    'upgrade-guide/overview',
93
    'upgrade-guide/data_migration',
94
    '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
95
    # Plain-style documentation generation stuff
96
    'release-notes/NEWS',
6622.1.23 by Jelmer Vernooij
More renames in English docs.
97
    'user-reference/brz_man',
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
98
    'user-guide/index-plain',
4871.6.2 by Neil Martinsen-Burrell
tweaks based on JAMs review
99
    'admin-guide/index-plain',
5462.5.8 by Andrew Bennetts
Tweaks to the sphinx build.
100
    # Templates
101
    'release-notes/release-template',
102
    '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
103
    # Miscellaneous
104
    'user-reference/readme',
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
105
]
106