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