/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/doc_generate/conf.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/doc_generate/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
# All configuration values have a default; values that are commented out
 
7
# serve to show the default.
 
8
 
 
9
# FIXME: better move the content of doc/en/conf.py here and cleanup the result
 
10
# -- vila 20100428
 
11
 
 
12
# If extensions (or modules to document with autodoc) are in another directory,
 
13
# add these directories to sys.path here. If the directory is relative to the
 
14
# documentation root, use os.path.abspath to make it absolute, like shown here.
 
15
# sys.path.append(os.path.abspath('.'))
 
16
 
 
17
 
 
18
# -- General configuration -----------------------------------------------------
 
19
 
 
20
# Add any Sphinx extension module names here, as strings. They can be extensions
 
21
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 
22
extensions = [
 
23
    'sphinx.ext.ifconfig',
 
24
    'sphinx.ext.autodoc',
 
25
    'sphinx.ext.intersphinx',
 
26
    'sphinx_epytext',
 
27
    # 'sphinxcontrib.napoleon', # TODO: for Google docstrings
 
28
    ]
 
29
 
 
30
# Add any paths that contain templates here, relative to this directory.
 
31
templates_path = ['_templates']
 
32
 
 
33
# The suffix of source filenames.
 
34
source_suffix = '.txt'
 
35
 
 
36
# The encoding of source files.
 
37
#source_encoding = 'utf-8'
 
38
 
 
39
# The master toctree document.
 
40
master_doc = 'index'
 
41
 
 
42
# General information about the project.
 
43
project = u'Breezy'
 
44
copyright = u'2009-2011 Canonical Ltd, 2017-2018 Breezy Developers'
 
45
 
 
46
# The version info for the project you're documenting, acts as replacement for
 
47
# |version| and |release|, also used in various other places throughout the
 
48
# built documents.
 
49
#
 
50
# The short X.Y version.
 
51
import breezy
 
52
version = '.'.join(str(p) for p in breezy.version_info[:2])
 
53
# The full version, including alpha/beta/rc tags.
 
54
release = breezy.version_string
 
55
 
 
56
# The language for content autogenerated by Sphinx. Refer to documentation
 
57
# for a list of supported languages.
 
58
#language = None
 
59
 
 
60
# There are two options for replacing |today|: either, you set today to some
 
61
# non-false value, then it is used:
 
62
#today = ''
 
63
# Else, today_fmt is used as the format for a strftime call.
 
64
#today_fmt = '%B %d, %Y'
 
65
 
 
66
# List of documents that shouldn't be included in the build.
 
67
#unused_docs = []
 
68
 
 
69
# List of directories, relative to source directory, that shouldn't be searched
 
70
# for source files.
 
71
exclude_trees = ['_build']
 
72
 
 
73
# The reST default role (used for this markup: `text`) to use for all documents.
 
74
#default_role = None
 
75
 
 
76
# If true, '()' will be appended to :func: etc. cross-reference text.
 
77
#add_function_parentheses = True
 
78
 
 
79
# If true, the current module name will be prepended to all description
 
80
# unit titles (such as .. function::).
 
81
#add_module_names = True
 
82
 
 
83
# If true, sectionauthor and moduleauthor directives will be shown in the
 
84
# output. They are ignored by default.
 
85
#show_authors = False
 
86
 
 
87
# The name of the Pygments (syntax highlighting) style to use.
 
88
pygments_style = 'sphinx'
 
89
 
 
90
# A list of ignored prefixes for module index sorting.
 
91
#modindex_common_prefix = []
 
92
 
 
93
 
 
94
# -- Options for HTML output ---------------------------------------------------
 
95
 
 
96
# The theme to use for HTML and HTML Help pages.  Major themes that come with
 
97
# Sphinx are currently 'default' and 'sphinxdoc'.
 
98
html_theme = 'agogo'
 
99
 
 
100
# Theme options are theme-specific and customize the look and feel of a theme
 
101
# further.  For a list of options available for each theme, see the
 
102
# documentation.
 
103
html_theme_options = {
 
104
    # Unfortunately, the right sidebar breaks under IE6 and maybe IE7.
 
105
    # So we stick with the default left placement to cater for users stuck
 
106
    # on those browsers.
 
107
    # 'rightsidebar': True,
 
108
 
 
109
    # Non-document areas: header (relbar), footer, sidebar, etc.
 
110
    # Some useful colours here:
 
111
    # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
 
112
    #   midnightblue
 
113
    # * gray: dimgray, slategray, lightslategray
 
114
    #'sidebarbgcolor': "cornflowerblue",
 
115
    #'sidebarlinkcolor': "midnightblue",
 
116
    #'relbarbgcolor': "darkblue",
 
117
    #'footerbgcolor': "lightslategray",
 
118
 
 
119
    # Text, heading and code colouring
 
120
    #'codebgcolor': "lightyellow",
 
121
    #'codetextcolor': "firebrick",
 
122
    #'linkcolor': "mediumblue",
 
123
    }
 
124
 
 
125
# Add any paths that contain custom themes here, relative to this directory.
 
126
#html_theme_path = []
 
127
 
 
128
# The name for this set of Sphinx documents.  If None, it defaults to
 
129
# "<project> v<release> documentation".
 
130
#html_title = None
 
131
 
 
132
# A shorter title for the navigation bar.  Default is the same as html_title.
 
133
#html_short_title = None
 
134
 
 
135
# The name of an image file (relative to this directory) to place at the top
 
136
# of the sidebar.
 
137
#html_logo = None
 
138
 
 
139
# The name of an image file (within the static path) to use as favicon of the
 
140
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 
141
# pixels large.
 
142
# TODO(jelmer): add a brz.ico
 
143
# html_favicon = "brz.ico"
 
144
 
 
145
# Add any paths that contain custom static files (such as style sheets) here,
 
146
# relative to this directory. They are copied after the builtin static files,
 
147
# so a file named "default.css" will overwrite the builtin "default.css".
 
148
html_static_path = ['_static']
 
149
 
 
150
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 
151
# using the given strftime format.
 
152
#html_last_updated_fmt = '%b %d, %Y'
 
153
 
 
154
# If true, SmartyPants will be used to convert quotes and dashes to
 
155
# typographically correct entities.
 
156
#html_use_smartypants = True
 
157
 
 
158
# Custom sidebar templates, maps document names to template names.
 
159
#html_sidebars = {}
 
160
 
 
161
# Additional templates that should be rendered to pages, maps page names to
 
162
# template names.
 
163
#html_additional_pages = {}
 
164
 
 
165
# If false, no module index is generated.
 
166
html_use_modindex = False
 
167
 
 
168
# If false, no index is generated.
 
169
html_use_index = False
 
170
 
 
171
# If true, the index is split into individual pages for each letter.
 
172
#html_split_index = False
 
173
 
 
174
# If true, links to the reST sources are added to the pages.
 
175
html_show_sourcelink = True
 
176
 
 
177
# If true, an OpenSearch description file will be output, and all pages will
 
178
# contain a <link> tag referring to it.  The value of this option must be the
 
179
# base URL from which the finished HTML is served.
 
180
#html_use_opensearch = ''
 
181
 
 
182
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 
183
#html_file_suffix = ''
 
184
 
 
185
# Output file base name for HTML help builder.
 
186
htmlhelp_basename = 'brz-docs'
 
187
 
 
188
 
 
189
# -- Options for LaTeX output --------------------------------------------------
 
190
 
 
191
# The paper size ('letter' or 'a4').
 
192
#latex_paper_size = 'letter'
 
193
 
 
194
# The font size ('10pt', '11pt' or '12pt').
 
195
#latex_font_size = '10pt'
 
196
 
 
197
# Grouping the document tree into LaTeX files. List of tuples
 
198
# (source start file, target name, title, author, documentclass [howto/manual]).
 
199
latex_documents = []
 
200
 
 
201
# The name of an image file (relative to this directory) to place at the top of
 
202
# the title page.
 
203
# latex_logo = '../Bazaar-Logo-For-Manuals.png'
 
204
 
 
205
# For "manual" documents, if this is true, then toplevel headings are parts,
 
206
# not chapters.
 
207
#latex_use_parts = False
 
208
 
 
209
# Additional stuff for the LaTeX preamble.
 
210
#latex_preamble = ''
 
211
 
 
212
# Documents to append as an appendix to all manuals.
 
213
#latex_appendices = []
 
214
 
 
215
# If false, no module index is generated.
 
216
#latex_use_modindex = True
 
217
 
 
218
 
 
219
# -- Bazaar-specific configuration ---------------------------------------------
 
220
 
 
221
# Authors of the documents
 
222
brz_team = u'Breezy Developers'
 
223
 
 
224
intersphinx_mapping = {
 
225
    'python': ('https://docs.python.org/3', None),
 
226
    'testtools': ('https://testtools.readthedocs.io/en/latest', None),
 
227
    'configobj': ('https://configobj.readthedocs.io/en/latest', None),
 
228
    'dulwich': ('https://dulwich.readthedocs.io/en/latest', None),
 
229
}