~ubuntu-branches/ubuntu/trusty/virtualenvwrapper/trusty-proposed

« back to all changes in this revision

Viewing changes to .pc/remove_bitbucket_support.patch/docs/sphinx/conf.py

  • Committer: Bazaar Package Importer
  • Author(s): Jan Dittberner
  • Date: 2011-08-14 19:54:16 UTC
  • mfrom: (1.2.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20110814195416-05rds6ctun2yc69a
Tags: 2.8-1
* New upstream version.
* refresh debian/patches/debianspecific-setup.py.patch
* debian/control: get rid of Build-Depends-Indep
* switch to dh_python2 and dh_sphinxdoc
  - debian/control:
     - remove Build-Depends python-support
     - bump Build-Depends python to 2.6.6-3~
     - bump Build-Depends python-spinx to 1.0.7+dfsg-1~
     - add ${sphinxdoc:Depends} and libjs-sphinxdoc to Depends
     - remove libjs-jquery from Depends
  - debian/rules:
     - add --with python2,sphinxdoc in debian/rules
     - don't dh_link jquery.js
     - don't remove _sources, .doctrees and jquery.js manually
* add japanese sphinx documentation
  - debian/rules: add ja to lang for loop
  - add debian/virtualenvwrapper.doc-base.ja
  - add /usr/share/doc/virtualenvwrapper/ja to debian/virtualenvwrapper.dirs
* debian/rules:
  - replace copies of sphinx's _static directory in ja and es with symlinks
    to en
  - simplify sphinx build and set language
* use upstream sphinx configuration and remove bitbucket usage via
  debian/patches/remove_bitbucket_support.patch
* don't compress .txt files, to enable sphinx doc search

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# -*- coding: utf-8 -*-
 
2
#
 
3
# virtualenvwrapper documentation build configuration file, created by
 
4
# sphinx-quickstart on Thu May 28 22:35:13 2009.
 
5
#
 
6
# This file is execfile()d with the current directory set to its containing dir.
 
7
#
 
8
# Note that not all possible configuration values are present in this
 
9
# autogenerated file.
 
10
#
 
11
# All configuration values have a default; values that are commented out
 
12
# serve to show the default.
 
13
 
 
14
import sys, os
 
15
 
 
16
# If extensions (or modules to document with autodoc) are in another directory,
 
17
# add these directories to sys.path here. If the directory is relative to the
 
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
 
19
#sys.path.append(os.path.abspath('.'))
 
20
 
 
21
# -- General configuration -----------------------------------------------------
 
22
 
 
23
# Add any Sphinx extension module names here, as strings. They can be extensions
 
24
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 
25
extensions = [ 'sphinxcontrib.bitbucket' ]
 
26
 
 
27
bitbucket_project_url = 'http://bitbucket.org/dhellmann/virtualenvwrapper/'
 
28
 
 
29
# Add any paths that contain templates here, relative to this directory.
 
30
#templates_path = ['pkg/templates']
 
31
 
 
32
# The suffix of source filenames.
 
33
source_suffix = '.rst'
 
34
 
 
35
# The encoding of source files.
 
36
#source_encoding = 'utf-8'
 
37
 
 
38
# The master toctree document.
 
39
master_doc = 'index'
 
40
 
 
41
# General information about the project.
 
42
project = u'virtualenvwrapper'
 
43
copyright = u'2009-2011, Doug Hellmann'
 
44
 
 
45
# The version info for the project you're documenting, acts as replacement for
 
46
# |version| and |release|, also used in various other places throughout the
 
47
# built documents.
 
48
#
 
49
# The short X.Y version.
 
50
version = '2.8'
 
51
# The full version, including alpha/beta/rc tags.
 
52
release = version
 
53
 
 
54
# The language for content autogenerated by Sphinx. Refer to documentation
 
55
# for a list of supported languages.
 
56
#language = None
 
57
 
 
58
# There are two options for replacing |today|: either, you set today to some
 
59
# non-false value, then it is used:
 
60
#today = ''
 
61
# Else, today_fmt is used as the format for a strftime call.
 
62
#today_fmt = '%B %d, %Y'
 
63
 
 
64
# List of documents that shouldn't be included in the build.
 
65
#unused_docs = []
 
66
 
 
67
# List of directories, relative to source directory, that shouldn't be searched
 
68
# for source files.
 
69
exclude_trees = ['_build']
 
70
 
 
71
# The reST default role (used for this markup: `text`) to use for all documents.
 
72
#default_role = None
 
73
 
 
74
# If true, '()' will be appended to :func: etc. cross-reference text.
 
75
#add_function_parentheses = True
 
76
 
 
77
# If true, the current module name will be prepended to all description
 
78
# unit titles (such as .. function::).
 
79
#add_module_names = True
 
80
 
 
81
# If true, sectionauthor and moduleauthor directives will be shown in the
 
82
# output. They are ignored by default.
 
83
#show_authors = False
 
84
 
 
85
# The name of the Pygments (syntax highlighting) style to use.
 
86
pygments_style = 'sphinx'
 
87
 
 
88
# A list of ignored prefixes for module index sorting.
 
89
#modindex_common_prefix = []
 
90
 
 
91
 
 
92
# -- Options for HTML output ---------------------------------------------------
 
93
 
 
94
# The theme to use for HTML and HTML Help pages.  Major themes that come with
 
95
# Sphinx are currently 'default' and 'sphinxdoc'.
 
96
html_theme = 'nature'
 
97
 
 
98
# Theme options are theme-specific and customize the look and feel of a theme
 
99
# further.  For a list of options available for each theme, see the
 
100
# documentation.
 
101
#html_theme_options = {}
 
102
 
 
103
# Add any paths that contain custom themes here, relative to this directory.
 
104
#html_theme_path = []
 
105
 
 
106
# The name for this set of Sphinx documents.  If None, it defaults to
 
107
# "<project> v<release> documentation".
 
108
#html_title = None
 
109
 
 
110
# A shorter title for the navigation bar.  Default is the same as html_title.
 
111
#html_short_title = None
 
112
 
 
113
# The name of an image file (relative to this directory) to place at the top
 
114
# of the sidebar.
 
115
#html_logo = None
 
116
 
 
117
# The name of an image file (within the static path) to use as favicon of the
 
118
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 
119
# pixels large.
 
120
#html_favicon = None
 
121
 
 
122
# Add any paths that contain custom static files (such as style sheets) here,
 
123
# relative to this directory. They are copied after the builtin static files,
 
124
# so a file named "default.css" will overwrite the builtin "default.css".
 
125
#html_static_path = ['static']
 
126
 
 
127
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 
128
# using the given strftime format.
 
129
#html_last_updated_fmt = '%b %d, %Y'
 
130
 
 
131
# If true, SmartyPants will be used to convert quotes and dashes to
 
132
# typographically correct entities.
 
133
#html_use_smartypants = True
 
134
 
 
135
# Custom sidebar templates, maps document names to template names.
 
136
#html_sidebars = {}
 
137
 
 
138
# Additional templates that should be rendered to pages, maps page names to
 
139
# template names.
 
140
#html_additional_pages = {}
 
141
 
 
142
# If false, no module index is generated.
 
143
html_use_modindex = False
 
144
 
 
145
# If false, no index is generated.
 
146
html_use_index = False
 
147
 
 
148
# If true, the index is split into individual pages for each letter.
 
149
#html_split_index = False
 
150
 
 
151
# If true, links to the reST sources are added to the pages.
 
152
#html_show_sourcelink = True
 
153
 
 
154
# If true, an OpenSearch description file will be output, and all pages will
 
155
# contain a <link> tag referring to it.  The value of this option must be the
 
156
# base URL from which the finished HTML is served.
 
157
#html_use_opensearch = ''
 
158
 
 
159
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 
160
#html_file_suffix = ''
 
161
 
 
162
# Output file base name for HTML help builder.
 
163
htmlhelp_basename = 'virtualenvwrapperdoc'
 
164
 
 
165
 
 
166
# -- Options for LaTeX output --------------------------------------------------
 
167
 
 
168
# The paper size ('letter' or 'a4').
 
169
#latex_paper_size = 'letter'
 
170
 
 
171
# The font size ('10pt', '11pt' or '12pt').
 
172
#latex_font_size = '10pt'
 
173
 
 
174
# Grouping the document tree into LaTeX files. List of tuples
 
175
# (source start file, target name, title, author, documentclass [howto/manual]).
 
176
latex_documents = [
 
177
  ('index', 'virtualenvwrapper.tex', u'virtualenvwrapper Documentation',
 
178
   u'Doug Hellmann', 'manual'),
 
179
]
 
180
 
 
181
# The name of an image file (relative to this directory) to place at the top of
 
182
# the title page.
 
183
#latex_logo = None
 
184
 
 
185
# For "manual" documents, if this is true, then toplevel headings are parts,
 
186
# not chapters.
 
187
#latex_use_parts = False
 
188
 
 
189
# Additional stuff for the LaTeX preamble.
 
190
#latex_preamble = ''
 
191
 
 
192
# Documents to append as an appendix to all manuals.
 
193
#latex_appendices = []
 
194
 
 
195
# If false, no module index is generated.
 
196
#latex_use_modindex = True