~bzr-pqm/bzr/bzr.dev

4634.39.5 by Ian Clatworthy
move Spanish doc into it's own website/chm file
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.27 by Ian Clatworthy
reuse the central configuration
13
sys.path = [os.path.abspath('../..')] + sys.path
14
15
# Most of the configuration for Bazaar docs is defined here ...
5193.6.28 by Vincent Ladeuil
Fix remaining sphinx_conf references.
16
from bzrlib.doc_generate.conf import *
4634.39.27 by Ian Clatworthy
reuse the central configuration
17
18
19
## Configuration specific to this site ##
4634.39.5 by Ian Clatworthy
move Spanish doc into it's own website/chm file
20
21
# The locale code for this documentation set
22
bzr_locale = 'es'
23
4634.39.27 by Ian Clatworthy
reuse the central configuration
24
# Translations & supporting helper function
4634.39.5 by Ian Clatworthy
move Spanish doc into it's own website/chm file
25
bzr_titles = {
4634.39.9 by Ian Clatworthy
cleanups for Spanish docs
26
        u'Table of Contents (%s)': u'Contenidos (%s)',
27
        u'Bazaar User Guide': u'Guia de Usuario',
4634.39.5 by Ian Clatworthy
move Spanish doc into it's own website/chm file
28
        u'Bazaar User Reference': None,
29
        u'Bazaar Release Notes': None,
30
        u'Bazaar Upgrade Guide': None,
4634.39.9 by Ian Clatworthy
cleanups for Spanish docs
31
        u'Bazaar in five minutes': u'Bazaar en cinco minutos',
4634.39.5 by Ian Clatworthy
move Spanish doc into it's own website/chm file
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
# The language for content autogenerated by Sphinx. Refer to documentation
40
# for a list of supported languages.
41
language = bzr_locale
42
43
# A shorter title for the navigation bar.  Default is the same as html_title.
44
html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
45
46
# Additional templates that should be rendered to pages, maps page names to
47
# template names.
48
#html_additional_pages = {'index': 'index.html'}
49
50
# Output file base name for HTML help builder.
4634.39.30 by Ian Clatworthy
tweak chm file naming
51
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
4634.39.5 by Ian Clatworthy
move Spanish doc into it's own website/chm file
52
53
# Grouping the document tree into LaTeX files. List of tuples
54
# (source start file, target name, title, author, documentclass [howto/manual]).
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
55
bzr_documents = [
4634.39.5 by Ian Clatworthy
move Spanish doc into it's own website/chm file
56
  # Manuals
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
57
  ('user-guide/index', 'bzr-%s-user-guide' % (bzr_locale,),
4634.39.13 by Ian Clatworthy
PDF generation for Spanish docs
58
    bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
59
  #('user-reference/bzr_man', 'bzr-%s-user-reference' % (bzr_locale,),
4634.39.9 by Ian Clatworthy
cleanups for Spanish docs
60
  #  bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
61
  #('release-notes/NEWS', 'bzr-%s-release-notes' % (bzr_locale,),
4634.39.9 by Ian Clatworthy
cleanups for Spanish docs
62
  #  bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
63
  #('upgrade-guide/index', 'bzr-%s-upgrade-guide' % (bzr_locale,),
4634.39.9 by Ian Clatworthy
cleanups for Spanish docs
64
  #  bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
4634.39.5 by Ian Clatworthy
move Spanish doc into it's own website/chm file
65
  # Tutorials
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
66
  ('mini-tutorial/index', 'bzr-%s-tutorial-mini' % (bzr_locale,),
4634.39.5 by Ian Clatworthy
move Spanish doc into it's own website/chm file
67
    bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
68
  #('tutorials/tutorial', 'bzr-%s-tutorial' % (bzr_locale,),
4634.39.9 by Ian Clatworthy
cleanups for Spanish docs
69
  #  bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
70
  #('tutorials/using_bazaar_with_launchpad',
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
71
  #  'bzr-%s-tutorial-with-launchpad' % (bzr_locale,),
4634.39.9 by Ian Clatworthy
cleanups for Spanish docs
72
  #  bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
73
  #('tutorials/centralized_workflow',
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
74
  #  'bzr-%s-tutorial-centralized' % (bzr_locale,),
4634.39.9 by Ian Clatworthy
cleanups for Spanish docs
75
  #  bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
4634.39.5 by Ian Clatworthy
move Spanish doc into it's own website/chm file
76
]
4634.39.43 by Ian Clatworthy
configure more documents to exclude from sphinx builds
77
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
78
latex_documents = [
79
    (start, target+'.tex', title, author, doc_class)
80
    for start, target, title, author, doc_class in bzr_documents
81
    ]
82
83
texinfo_documents = [
84
    (start, target, title, author, doc_class)
85
    for start, target, title, author, doc_class in bzr_documents
86
    ]
87
4634.39.43 by Ian Clatworthy
configure more documents to exclude from sphinx builds
88
# List of documents that shouldn't be included in the build.
89
unused_docs = [
90
    # Subtopics that get included
91
    'upgrade-guide/overview',
92
    'upgrade-guide/data_migration',
93
    'upgrade-guide/tips_and_tricks',
4634.39.45 by Ian Clatworthy
es/ru/developers docs to exclude from sphinx builds
94
    'user-guide/resolving_conflicts',
95
    'user-guide/version_info',
4634.39.43 by Ian Clatworthy
configure more documents to exclude from sphinx builds
96
    # Plain-style documentation generation stuff
97
    'user-guide/index-plain',
98
]
99