1# -*- coding: utf-8 -*- 2# 3# Jansson documentation build configuration file, created by 4# sphinx-quickstart on Sun Sep 5 21:47:20 2010. 5# 6# This file is execfile()d with the current directory set to its containing dir. 7# 8# Note that not all possible configuration values are present in this 9# autogenerated file. 10# 11# All configuration values have a default; values that are commented out 12# serve to show the default. 13 14import sys, os 15 16# If extensions (or modules to document with autodoc) are in another directory, 17# add these directories to sys.path here. If the directory is relative to the 18# documentation root, use os.path.abspath to make it absolute, like shown here. 19sys.path.insert(0, os.path.abspath('ext')) 20 21# -- General configuration ----------------------------------------------------- 22 23# If your documentation needs a minimal Sphinx version, state it here. 24needs_sphinx = '1.0' 25 26# Add any Sphinx extension module names here, as strings. They can be extensions 27# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28extensions = ['refcounting'] 29 30# Add any paths that contain templates here, relative to this directory. 31templates_path = ['_templates'] 32 33# The suffix of source filenames. 34source_suffix = '.rst' 35 36# The encoding of source files. 37#source_encoding = 'utf-8-sig' 38 39# The master toctree document. 40master_doc = 'index' 41 42# General information about the project. 43project = u'Jansson' 44copyright = u'2009-2016, Petri Lehtinen' 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. 51version = '2.9' 52# The full version, including alpha/beta/rc tags. 53release = version 54 55# The language for content autogenerated by Sphinx. Refer to documentation 56# for a list of supported languages. 57#language = None 58 59# There are two options for replacing |today|: either, you set today to some 60# non-false value, then it is used: 61#today = '' 62# Else, today_fmt is used as the format for a strftime call. 63#today_fmt = '%B %d, %Y' 64 65# List of patterns, relative to source directory, that match files and 66# directories to ignore when looking for source files. 67exclude_patterns = ['_build'] 68 69# The reST default role (used for this markup: `text`) to use for all documents. 70default_role = 'c:func' 71primary_domain = 'c' 72 73# If true, '()' will be appended to :func: etc. cross-reference text. 74#add_function_parentheses = True 75 76# If true, the current module name will be prepended to all description 77# unit titles (such as .. function::). 78#add_module_names = True 79 80# If true, sectionauthor and moduleauthor directives will be shown in the 81# output. They are ignored by default. 82#show_authors = False 83 84# The name of the Pygments (syntax highlighting) style to use. 85pygments_style = 'sphinx' 86 87# A list of ignored prefixes for module index sorting. 88#modindex_common_prefix = [] 89 90 91# -- Options for HTML output --------------------------------------------------- 92 93# The theme to use for HTML and HTML Help pages. See the documentation for 94# a list of builtin themes. 95#html_theme = 'default' 96 97# Theme options are theme-specific and customize the look and feel of a theme 98# further. For a list of options available for each theme, see the 99# documentation. 100#html_theme_options = {} 101 102# Add any paths that contain custom themes here, relative to this directory. 103#html_theme_path = [] 104 105# The name for this set of Sphinx documents. If None, it defaults to 106# "<project> v<release> documentation". 107#html_title = None 108 109# A shorter title for the navigation bar. Default is the same as html_title. 110#html_short_title = None 111 112# The name of an image file (relative to this directory) to place at the top 113# of the sidebar. 114#html_logo = None 115 116# The name of an image file (within the static path) to use as favicon of the 117# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 118# pixels large. 119#html_favicon = None 120 121# Add any paths that contain custom static files (such as style sheets) here, 122# relative to this directory. They are copied after the builtin static files, 123# so a file named "default.css" will overwrite the builtin "default.css". 124#html_static_path = ['_static'] 125 126# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 127# using the given strftime format. 128#html_last_updated_fmt = '%b %d, %Y' 129 130# If true, SmartyPants will be used to convert quotes and dashes to 131# typographically correct entities. 132#html_use_smartypants = True 133 134# Custom sidebar templates, maps document names to template names. 135#html_sidebars = {} 136 137# Additional templates that should be rendered to pages, maps page names to 138# template names. 139#html_additional_pages = {} 140 141# If false, no module index is generated. 142#html_domain_indices = True 143 144# If false, no index is generated. 145#html_use_index = True 146 147# If true, the index is split into individual pages for each letter. 148#html_split_index = False 149 150# If true, links to the reST sources are added to the pages. 151#html_show_sourcelink = True 152 153# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 154#html_show_sphinx = True 155 156# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 157#html_show_copyright = True 158 159# If true, an OpenSearch description file will be output, and all pages will 160# contain a <link> tag referring to it. The value of this option must be the 161# base URL from which the finished HTML is served. 162#html_use_opensearch = '' 163 164# This is the file name suffix for HTML files (e.g. ".xhtml"). 165#html_file_suffix = None 166 167# Output file base name for HTML help builder. 168htmlhelp_basename = 'Janssondoc' 169 170 171# -- Options for LaTeX output -------------------------------------------------- 172 173# The paper size ('letter' or 'a4'). 174#latex_paper_size = 'letter' 175 176# The font size ('10pt', '11pt' or '12pt'). 177#latex_font_size = '10pt' 178 179# Grouping the document tree into LaTeX files. List of tuples 180# (source start file, target name, title, author, documentclass [howto/manual]). 181latex_documents = [ 182 ('index', 'Jansson.tex', u'Jansson Documentation', 183 u'Petri Lehtinen', 'manual'), 184] 185 186# The name of an image file (relative to this directory) to place at the top of 187# the title page. 188#latex_logo = None 189 190# For "manual" documents, if this is true, then toplevel headings are parts, 191# not chapters. 192#latex_use_parts = False 193 194# If true, show page references after internal links. 195#latex_show_pagerefs = False 196 197# If true, show URL addresses after external links. 198#latex_show_urls = False 199 200# Additional stuff for the LaTeX preamble. 201#latex_preamble = '' 202 203# Documents to append as an appendix to all manuals. 204#latex_appendices = [] 205 206# If false, no module index is generated. 207#latex_domain_indices = True 208 209 210# -- Options for manual page output -------------------------------------------- 211 212# One entry per manual page. List of tuples 213# (source start file, name, description, authors, manual section). 214man_pages = [ 215 ('index', 'jansson', u'Jansson Documentation', 216 [u'Petri Lehtinen'], 1) 217] 218