← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/conf.py

Major code cleanup.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/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.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
# A shorter title for the navigation bar.  Default is the same as html_title.
 
25
html_short_title = u"Developer Document Catalog (%s)" % (release,)
 
26
 
 
27
# Additional templates that should be rendered to pages, maps page names to
 
28
# template names.
 
29
#html_additional_pages = {'index': 'index.html'}
 
30
 
 
31
# Output file base name for HTML help builder.
 
32
htmlhelp_basename = 'bzr-developers'
 
33
 
 
34
# Grouping the document tree into LaTeX files. List of tuples
 
35
# (source start file, target name, title, author, documentclass [howto/manual]).
 
36
latex_documents = [
 
37
  ('HACKING', 'bzr-en-developer-guide.tex', u'Bazaar Developer Guide',
 
38
   u'Bazaar Developers', 'manual'),
 
39
  ('testing', 'bzr-en-testing-guide.tex', u'Bazaar Testing Guide',
 
40
   u'Bazaar Developers', 'manual'),
 
41
  ('overview', 'bzr-en-architecture-overview.tex', u'Bazaar Architecture Overview',
 
42
   u'Bazaar Developers', 'howto'),
 
43
  ('integration', 'bzr-en-integration-guide.tex', u'Bazaar Integration Guide',
 
44
   u'Bazaar Developers', 'howto'),
 
45
]
 
46
 
 
47
# List of documents that shouldn't be included in the build.
 
48
# Note: Maybe some of them *ought* to be linked in somewhere?
 
49
unused_docs = [
 
50
  'add',
 
51
  'annotate',
 
52
  'bundle-creation',
 
53
  'bundle-format4',
 
54
  'check',
 
55
  'commit',
 
56
  'diff',
 
57
  'directory-fingerprints',
 
58
  'gc',
 
59
  'index-plain',
 
60
  'incremental-push-pull',
 
61
  'initial-push-pull',
 
62
  'merge-scaling',
 
63
  'missing',
 
64
  'performance-roadmap-rationale',
 
65
  'performance-use-case-analysis',
 
66
  'planned-change-integration',
 
67
  'planned-performance-changes',
 
68
  'revert',
 
69
  'status',
 
70
  'uncommit',
 
71
]