conf-common.py 10.8 KB
Newer Older
Glenn Walbran's avatar
Glenn Walbran committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# -*- coding: utf-8 -*-
#
# Mahara documentation build configuration file, created by
# sphinx-quickstart on Tue Nov 15 17:04:37 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

from __future__ import unicode_literals
15
import sys, os, datetime
Glenn Walbran's avatar
Glenn Walbran committed
16
17
18

html_context = {
  #mahara_releases is used to build the user manual links
19
  'mahara_releases': ['20.04', '19.10', '19.04'],
20
  #all_mahara_releases is used to build the full list of user manual links on all_releases.html
21
  'all_mahara_releases': ['20.04', '19.10', '19.04', '18.10', '18.04', '17.10', '17.04', '16.10', '16.04', '15.10', '15.04', '1.10', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4']
Glenn Walbran's avatar
Glenn Walbran committed
22
23
24
25
26
27
28
29
30
31
}

# 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.insert(0, os.path.abspath('.'))

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
32
needs_sphinx = '1.8.5'
Glenn Walbran's avatar
Glenn Walbran committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

gettext_additional_targets = ['image', 'figure']

# NOTE:
# This image translation only works for images/figures that are specified as
# [<filepath>/]<filename>.*
#
# That is you cannot specify the file extension for image translations to work.
#
# This is because of an oddity in the Sphinx asset collection. Hopefully this
# will change in the future.
figure_language_filename = "/images-translated/{language}{root}{ext}"

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinxjp.themes.basicstrap']

# Add support for showing ToDo list for the whole documentation.
todo_include_todos = False

# Add any paths that contain templates here, relative to this directory.
#templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'Mahara'
67
68
69
copyright_year_end = datetime.datetime.now().year

copyright = "2011-{} Catalyst IT and others".format(copyright_year_end)
Glenn Walbran's avatar
Glenn Walbran committed
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
#version = '17.04'
# The full version, including alpha/beta/rc tags.
#release = '17.04'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []


# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = 'mahara'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
124
html_theme_options = {'googlewebfont': True, 'googlewebfont_url': 'https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,700,700i,800,800i', 'googlewebfont_style': "font-family: 'Open Sans', sans-serif",}
Glenn Walbran's avatar
Glenn Walbran committed
125
126
127
128
129
130
131
132
133

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = ['.']
import sphinxjp.themes.basicstrap as basicstrap

html_theme_path = ['.', basicstrap.template_path]

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
134
html_title = "Mahara {} manual".format(release)
Glenn Walbran's avatar
Glenn Walbran committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

# A shorter title for the navigation bar.  Default is the same as html_title.
html_short_title = "" # Left blank because a background image is placed in the css with text

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
#html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

161
162
163
# prevent multiple backslashes (in Japanese)
smartquotes_excludes = ({'languages': [], 'builders': ['man', 'text']})

Glenn Walbran's avatar
Glenn Walbran committed
164
165
166
167
168
169
170
# Custom sidebar templates, maps document names to template names.
html_sidebars = {'**':['localtoc.html', 'relations.html', 'searchbox.html', 'links.html', 'translations.html']}
# html_sidebars = {'**':['localtoc.html', 'relations.html', 'searchbox.html', 'translations.html']}


# Additional templates that should be rendered to pages, maps page names to
# template names.
171
html_additional_pages = {'all-releases': 'all-releases.html'}
Glenn Walbran's avatar
Glenn Walbran committed
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'Maharadoc'


# -- Options for LaTeX output --------------------------------------------------

# The name of an image file (relative to this directory) to place at the top of
# the title page.
Glenn Walbran's avatar
Glenn Walbran committed
207
latex_logo = 'mahara/static/mahara-latex.png'
Glenn Walbran's avatar
Glenn Walbran committed
208
209
210

latex_use_parts = False

211
LATEX_MAINFONT = 'FreeSerif'
Glenn Walbran's avatar
Glenn Walbran committed
212
LATEX_BABEL = '\\usepackage{babel}'
213
LATEX_TITLE = "Mahara manual"
Glenn Walbran's avatar
Glenn Walbran committed
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
LATEX_AUTHOR = "Catalyst IT and others"

language = os.environ.get('sphinxlang', 'en')

if language == 'ja':
    LATEX_MAINFONT = 'WenQuanYi Micro Hei'
    LATEX_TITLE = "Mahara ユーザマニュアル"
    LATEX_AUTHOR = "Catalyst IT および他の著者。"
elif language.startswith('zh'):
    LATEX_MAINFONT = 'WenQuanYi Micro Hei'
elif language == 'nl':
    LATEX_BABEL = '\\usepackage[dutch]{babel}'
    LATEX_TITLE = "Mahara handleiding"
    LATEX_AUTHOR = "Catalyst IT en andere autheurs."
elif language == 'de':
    LATEX_BABEL = '\\usepackage[german]{babel}'
    LATEX_TITLE = "Mahara Benutzerhandbuch"
    LATEX_AUTHOR = "Catalyst IT und andere Autoren"
elif language == 'fr':
    LATEX_BABEL = '\\usepackage[frenchb]{babel}'
    LATEX_TITLE = "Manuel de l'Utilisateur de Mahara"
    LATEX_AUTHOR = "Catalyst IT et d'autres auteurs"

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
    ('index', 'Mahara.tex', LATEX_TITLE, LATEX_AUTHOR, 'manual')
]

LATEX_PREAMBLE = '''
\\RequirePackage{ifxetex}
\\RequireXeTeX
\\usepackage{xltxtra}
\\usepackage{verbatim}
\\usepackage{url}
\\usepackage{fontspec}
250
251
252
\\usepackage{opensans}
\\usepackage{sectsty}
\\setmainfont{%(font)s}
Glenn Walbran's avatar
Glenn Walbran committed
253
254
255
\\usepackage{amsmath}
\\usepackage{amsfonts}
\\usepackage{xunicode}
256
''' % {'font': LATEX_MAINFONT}
Glenn Walbran's avatar
Glenn Walbran committed
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271

latex_elements = {
    'papersize': 'a4',
    'pointsize': '10pt',
    'inputenc': '',
    'babel': LATEX_BABEL,
    'preamble': LATEX_PREAMBLE,
}


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
272
    ('index', 'mahara', 'Mahara manual',
Glenn Walbran's avatar
Glenn Walbran committed
273
274
275
276
277
278
279
     ['Catalyst IT and others'], 1)
]


# -- Options for Epub output ---------------------------------------------------

# Bibliographic Dublin Core info.
280
epub_title = 'Mahara {} manual'.format(release)
Glenn Walbran's avatar
Glenn Walbran committed
281
282
epub_author = 'Catalyst IT and others'
epub_publisher = 'Mahara Project'
283
epub_copyright = '2011-{} Dual licensed under Creative Commons BY-SA 3.0 unported and GNU General Public License version 3 or later, Catalyst IT and others'.format(copyright_year_end)
Glenn Walbran's avatar
Glenn Walbran committed
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316

# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''

# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''

# A unique identification for the text.
#epub_uid = ''

# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []

# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []

# A list of files that should not be packed into the epub file.
#epub_exclude_files = []

# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3

# Allow duplicate toc entries.
#epub_tocdup = True

locale_dirs =  ["locales/"]