Rich Lane | 4db1fdc | 2013-06-03 20:11:01 -0700 | [diff] [blame^] | 1 | # -*- coding: utf-8 -*- |
| 2 | # |
| 3 | # PyLoxi documentation build configuration file, created by |
| 4 | # sphinx-quickstart on Mon Jun 3 14:14:34 2013. |
| 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 | |
| 14 | import 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. |
| 19 | sys.path.insert(0, os.path.abspath('../../pyloxi')) |
| 20 | |
| 21 | import loxi |
| 22 | |
| 23 | # -- General configuration ----------------------------------------------------- |
| 24 | |
| 25 | # If your documentation needs a minimal Sphinx version, state it here. |
| 26 | #needs_sphinx = '1.0' |
| 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 = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] |
| 31 | |
| 32 | # Add any paths that contain templates here, relative to this directory. |
| 33 | templates_path = ['_templates'] |
| 34 | |
| 35 | # The suffix of source filenames. |
| 36 | source_suffix = '.rst' |
| 37 | |
| 38 | # The encoding of source files. |
| 39 | #source_encoding = 'utf-8-sig' |
| 40 | |
| 41 | # The master toctree document. |
| 42 | master_doc = 'index' |
| 43 | |
| 44 | # General information about the project. |
| 45 | project = u'PyLoxi' |
| 46 | copyright = u'2013, Big Switch Networks' |
| 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 = '' |
| 54 | # The full version, including alpha/beta/rc tags. |
| 55 | release = '' |
| 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 patterns, relative to source directory, that match files and |
| 68 | # directories to ignore when looking for source files. |
| 69 | exclude_patterns = ['_build'] |
| 70 | |
| 71 | # The reST default role (used for this markup: `text`) to use for all documents. |
| 72 | #default_role = None |
| 73 | |
| 74 | # If true, '()' will be appended to :func: etc. cross-reference text. |
| 75 | #add_function_parentheses = True |
| 76 | |
| 77 | # If true, the current module name will be prepended to all description |
| 78 | # unit titles (such as .. function::). |
| 79 | #add_module_names = True |
| 80 | |
| 81 | # If true, sectionauthor and moduleauthor directives will be shown in the |
| 82 | # output. They are ignored by default. |
| 83 | #show_authors = False |
| 84 | |
| 85 | # The name of the Pygments (syntax highlighting) style to use. |
| 86 | pygments_style = 'sphinx' |
| 87 | |
| 88 | # A list of ignored prefixes for module index sorting. |
| 89 | #modindex_common_prefix = [] |
| 90 | |
| 91 | |
| 92 | # -- Options for HTML output --------------------------------------------------- |
| 93 | |
| 94 | # The theme to use for HTML and HTML Help pages. See the documentation for |
| 95 | # a list of builtin themes. |
| 96 | html_theme = 'default' |
| 97 | |
| 98 | # Theme options are theme-specific and customize the look and feel of a theme |
| 99 | # further. For a list of options available for each theme, see the |
| 100 | # documentation. |
| 101 | #html_theme_options = {} |
| 102 | |
| 103 | # Add any paths that contain custom themes here, relative to this directory. |
| 104 | #html_theme_path = [] |
| 105 | |
| 106 | # The name for this set of Sphinx documents. If None, it defaults to |
| 107 | # "<project> v<release> documentation". |
| 108 | #html_title = None |
| 109 | |
| 110 | # A shorter title for the navigation bar. Default is the same as html_title. |
| 111 | #html_short_title = None |
| 112 | |
| 113 | # The name of an image file (relative to this directory) to place at the top |
| 114 | # of the sidebar. |
| 115 | #html_logo = None |
| 116 | |
| 117 | # The name of an image file (within the static path) to use as favicon of the |
| 118 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
| 119 | # pixels large. |
| 120 | #html_favicon = None |
| 121 | |
| 122 | # Add any paths that contain custom static files (such as style sheets) here, |
| 123 | # relative to this directory. They are copied after the builtin static files, |
| 124 | # so a file named "default.css" will overwrite the builtin "default.css". |
| 125 | html_static_path = ['_static'] |
| 126 | |
| 127 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| 128 | # using the given strftime format. |
| 129 | #html_last_updated_fmt = '%b %d, %Y' |
| 130 | |
| 131 | # If true, SmartyPants will be used to convert quotes and dashes to |
| 132 | # typographically correct entities. |
| 133 | #html_use_smartypants = True |
| 134 | |
| 135 | # Custom sidebar templates, maps document names to template names. |
| 136 | #html_sidebars = {} |
| 137 | |
| 138 | # Additional templates that should be rendered to pages, maps page names to |
| 139 | # template names. |
| 140 | #html_additional_pages = {} |
| 141 | |
| 142 | # If false, no module index is generated. |
| 143 | #html_domain_indices = True |
| 144 | |
| 145 | # If false, no index is generated. |
| 146 | #html_use_index = True |
| 147 | |
| 148 | # If true, the index is split into individual pages for each letter. |
| 149 | #html_split_index = False |
| 150 | |
| 151 | # If true, links to the reST sources are added to the pages. |
| 152 | #html_show_sourcelink = True |
| 153 | |
| 154 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
| 155 | #html_show_sphinx = True |
| 156 | |
| 157 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
| 158 | #html_show_copyright = True |
| 159 | |
| 160 | # If true, an OpenSearch description file will be output, and all pages will |
| 161 | # contain a <link> tag referring to it. The value of this option must be the |
| 162 | # base URL from which the finished HTML is served. |
| 163 | #html_use_opensearch = '' |
| 164 | |
| 165 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
| 166 | #html_file_suffix = None |
| 167 | |
| 168 | # Output file base name for HTML help builder. |
| 169 | htmlhelp_basename = 'PyLoxidoc' |
| 170 | |
| 171 | |
| 172 | # -- Options for LaTeX output -------------------------------------------------- |
| 173 | |
| 174 | latex_elements = { |
| 175 | # The paper size ('letterpaper' or 'a4paper'). |
| 176 | #'papersize': 'letterpaper', |
| 177 | |
| 178 | # The font size ('10pt', '11pt' or '12pt'). |
| 179 | #'pointsize': '10pt', |
| 180 | |
| 181 | # Additional stuff for the LaTeX preamble. |
| 182 | #'preamble': '', |
| 183 | } |
| 184 | |
| 185 | # Grouping the document tree into LaTeX files. List of tuples |
| 186 | # (source start file, target name, title, author, documentclass [howto/manual]). |
| 187 | latex_documents = [ |
| 188 | ('index', 'PyLoxi.tex', u'PyLoxi Documentation', |
| 189 | u'Author', 'manual'), |
| 190 | ] |
| 191 | |
| 192 | # The name of an image file (relative to this directory) to place at the top of |
| 193 | # the title page. |
| 194 | #latex_logo = None |
| 195 | |
| 196 | # For "manual" documents, if this is true, then toplevel headings are parts, |
| 197 | # not chapters. |
| 198 | #latex_use_parts = False |
| 199 | |
| 200 | # If true, show page references after internal links. |
| 201 | #latex_show_pagerefs = False |
| 202 | |
| 203 | # If true, show URL addresses after external links. |
| 204 | #latex_show_urls = False |
| 205 | |
| 206 | # Documents to append as an appendix to all manuals. |
| 207 | #latex_appendices = [] |
| 208 | |
| 209 | # If false, no module index is generated. |
| 210 | #latex_domain_indices = True |
| 211 | |
| 212 | |
| 213 | # -- Options for manual page output -------------------------------------------- |
| 214 | |
| 215 | # One entry per manual page. List of tuples |
| 216 | # (source start file, name, description, authors, manual section). |
| 217 | man_pages = [ |
| 218 | ('index', 'pyloxi', u'PyLoxi Documentation', |
| 219 | [u'Author'], 1) |
| 220 | ] |
| 221 | |
| 222 | # If true, show URL addresses after external links. |
| 223 | #man_show_urls = False |
| 224 | |
| 225 | |
| 226 | # -- Options for Texinfo output ------------------------------------------------ |
| 227 | |
| 228 | # Grouping the document tree into Texinfo files. List of tuples |
| 229 | # (source start file, target name, title, author, |
| 230 | # dir menu entry, description, category) |
| 231 | texinfo_documents = [ |
| 232 | ('index', 'PyLoxi', u'PyLoxi Documentation', |
| 233 | u'Author', 'PyLoxi', 'One line description of project.', |
| 234 | 'Miscellaneous'), |
| 235 | ] |
| 236 | |
| 237 | # Documents to append as an appendix to all manuals. |
| 238 | #texinfo_appendices = [] |
| 239 | |
| 240 | # If false, no module index is generated. |
| 241 | #texinfo_domain_indices = True |
| 242 | |
| 243 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
| 244 | #texinfo_show_urls = 'footnote' |
| 245 | |
| 246 | |
| 247 | # -- Options for Epub output --------------------------------------------------- |
| 248 | |
| 249 | # Bibliographic Dublin Core info. |
| 250 | epub_title = u'PyLoxi' |
| 251 | epub_author = u'Author' |
| 252 | epub_publisher = u'Author' |
| 253 | epub_copyright = u'2013, Author' |
| 254 | |
| 255 | # The language of the text. It defaults to the language option |
| 256 | # or en if the language is not set. |
| 257 | #epub_language = '' |
| 258 | |
| 259 | # The scheme of the identifier. Typical schemes are ISBN or URL. |
| 260 | #epub_scheme = '' |
| 261 | |
| 262 | # The unique identifier of the text. This can be a ISBN number |
| 263 | # or the project homepage. |
| 264 | #epub_identifier = '' |
| 265 | |
| 266 | # A unique identification for the text. |
| 267 | #epub_uid = '' |
| 268 | |
| 269 | # A tuple containing the cover image and cover page html template filenames. |
| 270 | #epub_cover = () |
| 271 | |
| 272 | # HTML files that should be inserted before the pages created by sphinx. |
| 273 | # The format is a list of tuples containing the path and title. |
| 274 | #epub_pre_files = [] |
| 275 | |
| 276 | # HTML files shat should be inserted after the pages created by sphinx. |
| 277 | # The format is a list of tuples containing the path and title. |
| 278 | #epub_post_files = [] |
| 279 | |
| 280 | # A list of files that should not be packed into the epub file. |
| 281 | #epub_exclude_files = [] |
| 282 | |
| 283 | # The depth of the table of contents in toc.ncx. |
| 284 | #epub_tocdepth = 3 |
| 285 | |
| 286 | # Allow duplicate toc entries. |
| 287 | #epub_tocdup = True |