diff options
Diffstat (limited to 'doc/developers/conf.py')
-rw-r--r-- | doc/developers/conf.py | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/doc/developers/conf.py b/doc/developers/conf.py new file mode 100644 index 0000000..8ed08f7 --- /dev/null +++ b/doc/developers/conf.py @@ -0,0 +1,81 @@ +# -*- coding: utf-8 -*- +# +# Bazaar documentation build configuration file, created by +# sphinx-quickstart on Tue Jul 21 17:04:52 2009. +# +# This file is execfile()d with the current directory set to its containing dir. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path = [os.path.abspath('../..')] + sys.path + +# Most of the configuration for Bazaar docs is defined here ... +from bzrlib.doc_generate.conf import * + + +## Configuration specific to this site ## + +# The locale code for this documentation set +bzr_locale = 'en' + +# A shorter title for the navigation bar. Default is the same as html_title. +html_short_title = u"Developer Document Catalog (%s)" % (release,) + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {'index': 'index.html'} + +# Output file base name for HTML help builder. +htmlhelp_basename = 'bzr-developers' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +bzr_documents = [ + ('HACKING', 'bzr-en-developer-guide', u'Bazaar Developer Guide', + u'Bazaar Developers', 'manual'), + ('testing', 'bzr-en-testing-guide', u'Bazaar Testing Guide', + u'Bazaar Developers', 'manual'), + ('overview', 'bzr-en-architecture-overview', u'Bazaar Architecture Overview', + u'Bazaar Developers', 'howto'), + ('integration', 'bzr-en-integration-guide', u'Bazaar Integration Guide', + u'Bazaar Developers', 'howto'), +] + +latex_documents = [ + (start, target+'.tex', title, author, doc_class) + for start, target, title, author, doc_class in bzr_documents + ] + +texinfo_documents = [ + (start, target, title, author, doc_class) + for start, target, title, author, doc_class in bzr_documents + ] + +# List of documents that shouldn't be included in the build. +# Note: Maybe some of them *ought* to be linked in somewhere? +unused_docs = [ + 'add', + 'annotate', + 'bundle-creation', + 'bundle-format4', + 'check', + 'commit', + 'diff', + 'directory-fingerprints', + 'gc', + 'index-plain', + 'incremental-push-pull', + 'initial-push-pull', + 'merge-scaling', + 'missing', + 'performance-roadmap-rationale', + 'performance-use-case-analysis', + 'planned-change-integration', + 'planned-performance-changes', + 'revert', + 'status', + 'uncommit', +] |