doc/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Jansson documentation build configuration file, created by
   4 # sphinx-quickstart on Thu Jul 30 11:35:32 2009.
   5 #
   6 # This file is execfile()d with the current directory set to its containing dir.
   7 #
   8 # The contents of this file are pickled, so don't put values in the namespace
   9 # that aren't pickleable (module imports are okay, they're removed automatically).
  10 #
  11 # Note that not all possible configuration values are present in this
  12 # autogenerated file.
  13 #
  14 # All configuration values have a default; values that are commented out
  15 # serve to show the default.
  16
  17 import sys, os
  18 sys.path.insert(0, os.path.abspath('ext'))
  19
  20 # If your extensions (or modules documented by autodoc) are in another directory,
  21 # add these directories to sys.path here. If the directory is relative to the
  22 # documentation root, use os.path.abspath to make it absolute, like shown here.
  23 #sys.path.append(os.path.abspath('.'))
  24
  25 # General configuration
  26 # ---------------------
  27
  28 # Add any Sphinx extension module names here, as strings. They can be extensions
  29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  30 extensions = ['refcounting']
  31
  32 # Add any paths that contain templates here, relative to this directory.
  33 templates_path = []
  34
  35 # The suffix of source filenames.
  36 source_suffix = '.rst'
  37
  38 # The encoding of source files.
  39 #source_encoding = 'utf-8'
  40
  41 # The master toctree document.
  42 master_doc = 'index'
  43
  44 # General information about the project.
  45 project = u'Jansson'
  46 copyright = u'2009, Petri Lehtinen'
  47
  48 # The version info for the project you're documenting, acts as replacement for
  49 # |version| and |release|, also used in various other places throughout the
  50 # built documents.
  51 #
  52 # The short X.Y version.
  53 version = '1.0'
  54 # The full version, including alpha/beta/rc tags.
  55 release = '1.0.2+'
  56
  57 # The language for content autogenerated by Sphinx. Refer to documentation
  58 # for a list of supported languages.
  59 #language = None
  60
  61 # There are two options for replacing |today|: either, you set today to some
  62 # non-false value, then it is used:
  63 #today = ''
  64 # Else, today_fmt is used as the format for a strftime call.
  65 #today_fmt = '%B %d, %Y'
  66
  67 # List of documents that shouldn't be included in the build.
  68 #unused_docs = []
  69
  70 # List of directories, relative to source directory, that shouldn't be searched
  71 # for source files.
  72 exclude_trees = ['.build']
  73
  74 # The reST default role (used for this markup: `text`) to use for all documents.
  75 #default_role = None
  76
  77 # If true, '()' will be appended to :func: etc. cross-reference text.
  78 #add_function_parentheses = True
  79
  80 # If true, the current module name will be prepended to all description
  81 # unit titles (such as .. function::).
  82 #add_module_names = True
  83
  84 # If true, sectionauthor and moduleauthor directives will be shown in the
  85 # output. They are ignored by default.
  86 #show_authors = False
  87
  88 # The name of the Pygments (syntax highlighting) style to use.
  89 pygments_style = 'sphinx'
  90
  91
  92 # Options for HTML output
  93 # -----------------------
  94
  95 # The style sheet to use for HTML and HTML Help pages. A file of that name
  96 # must exist either in Sphinx' static/ path, or in one of the custom paths
  97 # given in html_static_path.
  98 html_style = 'default.css'
  99
 100 # The name for this set of Sphinx documents.  If None, it defaults to
 101 # "<project> v<release> documentation".
 102 #html_title = None
 103
 104 # A shorter title for the navigation bar.  Default is the same as html_title.
 105 #html_short_title = None
 106
 107 # The name of an image file (relative to this directory) to place at the top
 108 # of the sidebar.
 109 #html_logo = None
 110
 111 # The name of an image file (within the static path) to use as favicon of the
 112 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 113 # pixels large.
 114 #html_favicon = None
 115
 116 # Add any paths that contain custom static files (such as style sheets) here,
 117 # relative to this directory. They are copied after the builtin static files,
 118 # so a file named "default.css" will overwrite the builtin "default.css".
 119 html_static_path = []
 120
 121 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 122 # using the given strftime format.
 123 #html_last_updated_fmt = '%b %d, %Y'
 124
 125 # If true, SmartyPants will be used to convert quotes and dashes to
 126 # typographically correct entities.
 127 #html_use_smartypants = True
 128
 129 # Custom sidebar templates, maps document names to template names.
 130 #html_sidebars = {}
 131
 132 # Additional templates that should be rendered to pages, maps page names to
 133 # template names.
 134 #html_additional_pages = {}
 135
 136 # If false, no module index is generated.
 137 #html_use_modindex = True
 138
 139 # If false, no index is generated.
 140 #html_use_index = True
 141
 142 # If true, the index is split into individual pages for each letter.
 143 #html_split_index = False
 144
 145 # If true, the reST sources are included in the HTML build as _sources/<name>.
 146 #html_copy_source = True
 147
 148 # If true, an OpenSearch description file will be output, and all pages will
 149 # contain a <link> tag referring to it.  The value of this option must be the
 150 # base URL from which the finished HTML is served.
 151 #html_use_opensearch = ''
 152
 153 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 154 #html_file_suffix = ''
 155
 156 # Output file base name for HTML help builder.
 157 htmlhelp_basename = 'Janssondoc'
 158
 159
 160 # Options for LaTeX output
 161 # ------------------------
 162
 163 # The paper size ('letter' or 'a4').
 164 #latex_paper_size = 'letter'
 165
 166 # The font size ('10pt', '11pt' or '12pt').
 167 #latex_font_size = '10pt'
 168
 169 # Grouping the document tree into LaTeX files. List of tuples
 170 # (source start file, target name, title, author, document class [howto/manual]).
 171 latex_documents = [
 172   ('index', 'Jansson.tex', ur'Jansson Documentation',
 173    ur'Petri Lehtinen', 'manual'),
 174 ]
 175
 176 # The name of an image file (relative to this directory) to place at the top of
 177 # the title page.
 178 #latex_logo = None
 179
 180 # For "manual" documents, if this is true, then toplevel headings are parts,
 181 # not chapters.
 182 #latex_use_parts = False
 183
 184 # Additional stuff for the LaTeX preamble.
 185 #latex_preamble = ''
 186
 187 # Documents to append as an appendix to all manuals.
 188 #latex_appendices = []
 189
 190 # If false, no module index is generated.
 191 #latex_use_modindex = True