~ubuntu-archive/britney/britney2

« back to all changes in this revision

Viewing changes to doc/conf.py

Committer: Niels Thykier
Date: 2017-12-03 12:06:37 UTC
Revision ID: git-v1:90e4bb6ba222fc99efeecdf7ad0743bc0e626ba7

Rewrite documentation in sphinx

Signed-off-by: Niels Thykier <niels@thykier.net>

files added:
doc/conf.py

doc/contributing-to-britney.rst

doc/index.rst

doc/short-intro-to-migrations.rst

doc/solutions-to-common-policy-issues.rst

doc/what-is-britney.rst

files removed:
doc/migrations-simplified.md

Show diffs side-by-side

added added

removed removed

doc/conf.py

#!/usr/bin/env python3

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

# britney2 documentation build configuration file, created by

# sphinx-quickstart on Sat Dec 2 12:34:27 2017.

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

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

import os

import sys

# Add .. so sphinx can find the britney2 modules.

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']

# 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 master toctree document.

master_doc = 'index'

# General information about the project.

project = 'britney2'

author = 'Niels Thykier'

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

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

release = ''

# 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

# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

# This patterns also effect to html_static_path and html_extra_path

exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

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

pygments_style = 'sphinx'

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

todo_include_todos = True

# -- 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 = 'classic'

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

# html_theme_options = {}

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

100

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

101

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

102

#html_static_path = ['_static']

103

104

# Custom sidebar templates, must be a dictionary that maps document names

105

# to template names.

106

107

# This is required for the alabaster theme

108

# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars

109

html_sidebars = {

110

'**': [

111

'relations.html', # needs 'show_related': True theme option to display

112

'searchbox.html',

113

]

114

}

115

116

117

# -- Options for HTMLHelp output ------------------------------------------

118

119

# Output file base name for HTML help builder.

120

htmlhelp_basename = 'britney2doc'

121

122

123

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

124

125

latex_elements = {

126

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

127

128

# 'papersize': 'letterpaper',

129

130

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

131

132

# 'pointsize': '10pt',

133

134

# Additional stuff for the LaTeX preamble.

135

136

# 'preamble': '',

137

138

# Latex figure (float) alignment

139

140

# 'figure_align': 'htbp',

141

}

142

143

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

144

# (source start file, target name, title,

145

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

146

latex_documents = [

147

(master_doc, 'britney2.tex', 'britney2 Documentation',

148

'Niels Thykier', 'manual'),

149

]

150

151

152

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

153

154

# One entry per manual page. List of tuples

155

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

156

man_pages = [

157

(master_doc, 'britney2', 'britney2 Documentation',

158

[author], 1)

159

]

160

161

162

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

163

164

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

165

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

166

# dir menu entry, description, category)

167

texinfo_documents = [

168

(master_doc, 'britney2', 'britney2 Documentation',

169

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

170

'Miscellaneous'),

171

]

172

Older »