~free.ekanayaka/txfixtures/sphinx-docs

« back to all changes in this revision

Viewing changes to doc/conf.py

Committer: Free Ekanayaka
Date: 2016-11-22 08:56:30 UTC
Revision ID: free.ekanayaka@canonical.com-20161122085630-jy51wonhyu357o0i

Add initial sphinx documentation

files added:
doc

doc/Makefile

doc/conf.py

doc/index.rst

files renamed:
README => README.rst

files modified:
.bzrignore

Makefile

setup.py

Show diffs side-by-side

added added

removed removed

doc/conf.py

#!/usr/bin/env python3

# -*- coding: utf-8 -*-

# txfixtures documentation build configuration file, created by

# sphinx-quickstart on Wed Nov 9 19:33:32 2016.

# 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.

import sys

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

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

# If your documentation needs a minimal Sphinx version, state it here.

#needs_sphinx = '1.0'

# 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.doctest',

'sphinx.ext.todo',

'sphinx.ext.coverage',

'sphinx.ext.viewcode',

'sphinx.ext.intersphinx',

]

# Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']

# The suffix(es) of source filenames.

# You can specify multiple suffix as a list of string:

# source_suffix = ['.rst', '.md']

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 = 'txfixtures'

author = 'Free Ekanayaka'

# 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.

from txfixtures import __version__

version = __version__

# The full version, including alpha/beta/rc tags.

release = __version__

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

# This is also used if you do content translation via gettext catalogs.

# Usually you set "language" from the command line for these cases.

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 = ['_build']

# 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

100

# output. They are ignored by default.

101

#show_authors = False

102

103

# The name of the Pygments (syntax highlighting) style to use.

104

pygments_style = 'sphinx'

105

106

# A list of ignored prefixes for module index sorting.

107

#modindex_common_prefix = []

108

109

# If true, keep warnings as "system message" paragraphs in the built documents.

110

#keep_warnings = False

111

112

# If true, `todo` and `todoList` produce output, else they produce nothing.

113

todo_include_todos = True

114

115

116

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

117

118

# The theme to use for HTML and HTML Help pages. See the documentation for

119

# a list of builtin themes.

120

html_theme = 'sphinx_rtd_theme'

121

122

# Theme options are theme-specific and customize the look and feel of a theme

123

# further. For a list of options available for each theme, see the

124

# documentation.

125

#html_theme_options = {}

126

127

# Add any paths that contain custom themes here, relative to this directory.

128

#html_theme_path = []

129

130

# The name for this set of Sphinx documents. If None, it defaults to

131

# "<project> v<release> documentation".

132

#html_title = None

133

134

# A shorter title for the navigation bar. Default is the same as html_title.

135

#html_short_title = None

136

137

# The name of an image file (relative to this directory) to place at the top

138

# of the sidebar.

139

#html_logo = None

140

141

# The name of an image file (relative to this directory) to use as a favicon of

142

# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32

143

# pixels large.

144

#html_favicon = None

145

146

# Add any paths that contain custom static files (such as style sheets) here,

147

# relative to this directory. They are copied after the builtin static files,

148

# so a file named "default.css" will overwrite the builtin "default.css".

149

html_static_path = ['_static']

150

151

# Add any extra paths that contain custom files (such as robots.txt or

152

# .htaccess) here, relative to this directory. These files are copied

153

# directly to the root of the documentation.

154

#html_extra_path = []

155

156

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

157

# using the given strftime format.

158

#html_last_updated_fmt = '%b %d, %Y'

159

160

# If true, SmartyPants will be used to convert quotes and dashes to

161

# typographically correct entities.

162

#html_use_smartypants = True

163

164

# Custom sidebar templates, maps document names to template names.

165

#html_sidebars = {}

166

167

# Additional templates that should be rendered to pages, maps page names to

168

# template names.

169

#html_additional_pages = {}

170

171

# If false, no module index is generated.

172

#html_domain_indices = True

173

174

# If false, no index is generated.

175

#html_use_index = True

176

177

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

178

#html_split_index = False

179

180

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

181

#html_show_sourcelink = True

182

183

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

184

#html_show_sphinx = True

185

186

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

187

#html_show_copyright = True

188

189

# If true, an OpenSearch description file will be output, and all pages will

190

# contain a <link> tag referring to it. The value of this option must be the

191

# base URL from which the finished HTML is served.

192

#html_use_opensearch = ''

193

194

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

195

#html_file_suffix = None

196

197

# Language to be used for generating the HTML full-text search index.

198

# Sphinx supports the following languages:

199

# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'

200

# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'

201

#html_search_language = 'en'

202

203

# A dictionary with options for the search language support, empty by default.

204

# Now only 'ja' uses this config value

205

#html_search_options = {'type': 'default'}

206

207

# The name of a javascript file (relative to the configuration directory) that

208

# implements a search results scorer. If empty, the default will be used.

209

#html_search_scorer = 'scorer.js'

210

211

# Output file base name for HTML help builder.

212

htmlhelp_basename = 'txfixturesdoc'

213

214

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

215

216

latex_elements = {

217

# The paper size ('letterpaper' or 'a4paper').

218

#'papersize': 'letterpaper',

219

220

# The font size ('10pt', '11pt' or '12pt').

221

#'pointsize': '10pt',

222

223

# Additional stuff for the LaTeX preamble.

224

#'preamble': '',

225

226

# Latex figure (float) alignment

227

#'figure_align': 'htbp',

228

}

229

230

# Grouping the document tree into LaTeX files. List of tuples

231

# (source start file, target name, title,

232

# author, documentclass [howto, manual, or own class]).

233

latex_documents = [

234

(master_doc, 'txfixtures.tex', 'txfixtures Documentation',

235

'Free Ekanayaka', 'manual'),

236

]

237

238

# The name of an image file (relative to this directory) to place at the top of

239

# the title page.

240

#latex_logo = None

241

242

# For "manual" documents, if this is true, then toplevel headings are parts,

243

# not chapters.

244

#latex_use_parts = False

245

246

# If true, show page references after internal links.

247

#latex_show_pagerefs = False

248

249

# If true, show URL addresses after external links.

250

#latex_show_urls = False

251

252

# Documents to append as an appendix to all manuals.

253

#latex_appendices = []

254

255

# If false, no module index is generated.

256

#latex_domain_indices = True

257

258

259

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

260

261

# One entry per manual page. List of tuples

262

# (source start file, name, description, authors, manual section).

263

man_pages = [

264

(master_doc, 'txfixtures', 'txfixtures Documentation',

265

[author], 1)

266

]

267

268

# If true, show URL addresses after external links.

269

#man_show_urls = False

270

271

272

# -- Options for Texinfo output -------------------------------------------

273

274

# Grouping the document tree into Texinfo files. List of tuples

275

# (source start file, target name, title, author,

276

# dir menu entry, description, category)

277

texinfo_documents = [

278

(master_doc, 'txfixtures', 'txfixtures Documentation',

279

author, 'txfixtures', 'One line description of project.',

280

'Miscellaneous'),

281

]

282

283

# Documents to append as an appendix to all manuals.

284

#texinfo_appendices = []

285

286

# If false, no module index is generated.

287

#texinfo_domain_indices = True

288

289

# How to display URL addresses: 'footnote', 'no', or 'inline'.

290

#texinfo_show_urls = 'footnote'

291

292

# If true, do not generate a @detailmenu in the "Top" node's menu.

293

#texinfo_no_detailmenu = False

294

295

intersphinx_mapping = {

296

'python': ('https://docs.python.org/3.5', None),

297

'twisted': ('http://twistedmatrix.com/documents/current/api', None),

298

'testtools': ('https://testtools.readthedocs.io/en/latest/', None),

299

}

Older »