~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/ru/conf.py

(mbp, for igc) generate docs using sphinx, and other doc cleanups

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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.sphinx_conf import *
 
17
 
 
18
 
 
19
## Configuration specific to this site ##
 
20
 
 
21
# The locale code for this documentation set
 
22
bzr_locale = 'ru'
 
23
 
 
24
# Translations & supporting helper function
 
25
bzr_titles = {
 
26
        u'Table of Contents (%s)': u'Содержание (%s)',
 
27
        u'Bazaar User Guide': None,
 
28
        u'Bazaar User Reference': None,
 
29
        u'Bazaar Release Notes': None,
 
30
        u'Bazaar Upgrade Guide': None,
 
31
        u'Bazaar in five minutes': u'Базар за пять минут',
 
32
        u'Bazaar Tutorial': u'Большой учебник',
 
33
        u'Using Bazaar With Launchpad': u'Использование Bazaar с Launchpad',
 
34
        u'Centralized Workflow Tutorial': u'Работа в централизованном стиле',
 
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.
 
51
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
 
52
 
 
53
# Grouping the document tree into LaTeX files. List of tuples
 
54
# (source start file, target name, title, author, documentclass [howto/manual]).
 
55
latex_documents = [
 
56
  # Manuals
 
57
  #('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
 
58
  #  bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
 
59
  #('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
 
60
  #  bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
 
61
  #('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
 
62
  #  bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
 
63
  #('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
 
64
  #  bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
 
65
  # Tutorials
 
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'),
 
76
]
 
77
 
 
78
# List of documents that shouldn't be included in the build.
 
79
unused_docs = [
 
80
    # Subtopics that get included
 
81
    'upgrade-guide/overview',
 
82
    'upgrade-guide/data_migration',
 
83
    'upgrade-guide/tips_and_tricks',
 
84
    'user-guide/branching_a_project',
 
85
    'user-guide/core_concepts',
 
86
    'user-guide/introducing_bazaar',
 
87
    'user-guide/specifying_revisions',
 
88
    'user-guide/stacked',
 
89
    'user-guide/using_checkouts',
 
90
    'user-guide/zen',
 
91
    # Plain-style documentation generation stuff
 
92
    'user-guide/index-plain',
 
93
]
 
94