conf.py 8.36 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Poezio Plugin development documentation build configuration file, created by
# sphinx-quickstart on Mon Mar  4 23:39:07 2013.
#
# 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.

mathieui's avatar
mathieui committed
15 16
import sys, os, time

17 18
sys.path.insert(0, os.path.abspath('../stub'))
sys.path.append(os.path.abspath('../../src/'))
mathieui's avatar
mathieui committed
19
sys.path.append(os.path.abspath('../../plugins/'))
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

# 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.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']

# Add any paths that contain templates here, relative to this directory.
36
#templates_path = ['theme/templates']
37 38 39 40 41 42 43 44 45 46 47

# 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.
mathieui's avatar
mathieui committed
48 49
project = 'Poezio'
copyright = '%s, Mathieu Pasquet - Florent Le Coz' % time.strftime('%Y')
50 51 52 53 54 55

# 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.
56
version = '0.9'
57
# The full version, including alpha/beta/rc tags.
mathieui's avatar
mathieui committed
58
release = '0.9'
mathieui's avatar
mathieui committed
59 60 61 62 63 64

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
65

mathieui's avatar
mathieui committed
66
# By default, highlight as Python 3.
67 68
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
mathieui's avatar
mathieui committed
69 70
highlight_language = 'python3'
language = 'python3'
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
# 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 ---------------------------------------------------

104 105
html_theme = "sphinx_rtd_theme"

mathieui's avatar
mathieui committed
106 107 108
html_theme_path = ['theme/']

html_short_title = '%s Documentation' % release
109

mathieui's avatar
mathieui committed
110 111 112
# 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'
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128


# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

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

# 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.
129
html_favicon = "poezio.png"
130 131 132 133

# 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".
mathieui's avatar
mathieui committed
134
html_static_path = ['theme/static']
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157

# 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

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# 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.
mathieui's avatar
mathieui committed
158
html_split_index = True
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174

# 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").
mathieui's avatar
mathieui committed
175
html_file_suffix = '.html'
176 177

# Output file base name for HTML help builder.
mathieui's avatar
mathieui committed
178
htmlhelp_basename = 'PoezioDoc'
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196


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

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

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

# Additional stuff for the LaTeX preamble.
#'preamble': '',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
mathieui's avatar
mathieui committed
197
  ('index', 'PoezioDoc.tex', 'Poezio Documentation',
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
   'Mathieu Pasquet - Florent Le Coz', 'manual'),
]

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

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

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


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
227 228
    ('configuration', 'poezio.cfg', 'Poezio Configuration File',
     ['Mathieu Pasquet', 'Florent Le Coz'], 7),
229 230 231 232
    ('keys', 'poezio.keys', 'Poezio Key Bindings',
     ['Mathieu Pasquet', 'Florent Le Coz'], 7),
    ('commands', 'poezio.commands', 'Poezio Commands',
     ['Mathieu Pasquet', 'Florent Le Coz'], 7),
233 234 235 236 237 238 239 240 241 242 243 244
]

# If true, show URL addresses after external links.
#man_show_urls = False


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

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
mathieui's avatar
mathieui committed
245 246
  ('index', 'PoezioDoc', 'Poezio Documentation',
   'Mathieu Pasquet - Florent Le Coz', 'PoezioDoc', 'Poezio Documentation',
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
   'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

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

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


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}