github.com/technosophos/deis@v1.7.1-0.20150915173815-f9005256004b/docs/conf.py (about) 1 # -*- coding: utf-8 -*- 2 # 3 # deis documentation build configuration file, created by 4 # sphinx-quickstart on Fri Jul 26 12:12:00 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 os 15 import sys 16 17 from mock import MagicMock 18 19 # Mock out modules that can't be installed at ReadTheDocs.org. 20 class MockModule(MagicMock): 21 @classmethod 22 def __getattr__(cls, name): 23 return MockModule() 24 25 MOCK_MODULES = ['django_auth_ldap', 'django_auth_ldap.config', 'django_auth_ldap.models', 'ldap'] 26 sys.modules.update((mod_name, MockModule()) for mod_name in MOCK_MODULES) 27 28 # If extensions (or modules to document with autodoc) are in another directory, 29 # add these directories to sys.path here. If the directory is relative to the 30 # documentation root, use os.path.abspath to make it absolute, like shown here. 31 32 sys.path.insert(0, os.path.abspath(os.path.join('..', 'controller'))) 33 # set up Django 34 os.environ['DJANGO_SETTINGS_MODULE'] = 'deis.settings' 35 os.environ['DATABASE_ENGINE'] = 'sqlite3' 36 os.environ['DATABASE_NAME'] = 'dummy.sqlite3' 37 from django.conf import settings # noqa 38 39 # -- General configuration ----------------------------------------------------- 40 41 # If your documentation needs a minimal Sphinx version, state it here. 42 #needs_sphinx = '1.0' 43 44 # Add any Sphinx extension module names here, as strings. They can be extensions 45 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 46 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary', 47 'sphinx.ext.viewcode'] 48 49 # default flags for auto-generated python code documetation 50 autodoc_default_flags = ['members', 'undoc-members'] 51 52 # Add any paths that contain templates here, relative to this directory. 53 templates_path = ['_templates'] 54 55 # The suffix of source filenames. 56 source_suffix = '.rst' 57 58 # The encoding of source files. 59 #source_encoding = 'utf-8-sig' 60 61 # The master toctree document. 62 master_doc = 'toctree' 63 64 # General information about the project. 65 project = u'deis' 66 copyright = u'2013, 2014 Engine Yard, Inc.' 67 68 # The version info for the project you're documenting, acts as replacement for 69 # |version| and |release|, also used in various other places throughout the 70 # built documents. 71 # 72 from deis import __version__ 73 74 # The short X.Y version. 75 version = __version__.rsplit('.', 1)[0] 76 # The full version, including alpha/beta/rc tags. 77 release = __version__ 78 79 # The language for content autogenerated by Sphinx. Refer to documentation 80 # for a list of supported languages. 81 #language = None 82 83 # There are two options for replacing |today|: either, you set today to some 84 # non-false value, then it is used: 85 #today = '' 86 # Else, today_fmt is used as the format for a strftime call. 87 #today_fmt = '%B %d, %Y' 88 89 # List of patterns, relative to source directory, that match files and 90 # directories to ignore when looking for source files. 91 exclude_patterns = ['_build', 'venv', '**/_*.rst'] 92 93 # The reST default role (used for this markup: `text`) to use for all documents. 94 #default_role = None 95 96 # If true, '()' will be appended to :func: etc. cross-reference text. 97 #add_function_parentheses = True 98 99 # If true, the current module name will be prepended to all description 100 # unit titles (such as .. function::). 101 #add_module_names = True 102 103 # If true, sectionauthor and moduleauthor directives will be shown in the 104 # output. They are ignored by default. 105 #show_authors = False 106 107 # The name of the Pygments (syntax highlighting) style to use. 108 pygments_style = 'sphinx' 109 110 # A list of ignored prefixes for module index sorting. 111 #modindex_common_prefix = [] 112 113 # If true, keep warnings as "system message" paragraphs in the built documents. 114 #keep_warnings = False 115 116 117 # -- Options for HTML output --------------------------------------------------- 118 119 # The theme to use for HTML and HTML Help pages. See the documentation for 120 # a list of builtin themes. 121 html_theme = 'deis' 122 123 # Theme options are theme-specific and customize the look and feel of a theme 124 # further. For a list of options available for each theme, see the 125 # documentation. 126 #html_theme_options = {} 127 128 # Add any paths that contain custom themes here, relative to this directory. 129 html_theme_path = ['theme'] 130 131 # The name for this set of Sphinx documents. If None, it defaults to 132 # "<project> v<release> documentation". 133 #html_title = None 134 135 # A shorter title for the navigation bar. Default is the same as html_title. 136 #html_short_title = None 137 138 # The name of an image file (relative to this directory) to place at the top 139 # of the sidebar. 140 #html_logo = None 141 142 # The name of an image file (within the static path) to use as favicon of the 143 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 144 # pixels large. 145 #html_favicon = None 146 147 # Add any paths that contain custom static files (such as style sheets) here, 148 # relative to this directory. They are copied after the builtin static files, 149 # so a file named "default.css" will overwrite the builtin "default.css". 150 html_static_path = ['../controller/web/static'] 151 152 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 153 # using the given strftime format. 154 #html_last_updated_fmt = '%b %d, %Y' 155 156 # If true, SmartyPants will be used to convert quotes and dashes to 157 # typographically correct entities. 158 html_use_smartypants = True 159 160 # html_add_permalinks = 'ΒΆ' 161 162 # Custom sidebar templates, maps document names to template names. 163 #html_sidebars = {} 164 165 # Additional templates that should be rendered to pages, maps page names to 166 # template names. 167 #html_additional_pages = {} 168 169 # If false, no module index is generated. 170 #html_domain_indices = True 171 172 # If false, no index is generated. 173 #html_use_index = True 174 175 # If true, the index is split into individual pages for each letter. 176 #html_split_index = False 177 178 # If true, links to the reST sources are added to the pages. 179 #html_show_sourcelink = True 180 181 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 182 #html_show_sphinx = True 183 184 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 185 #html_show_copyright = True 186 187 # If true, an OpenSearch description file will be output, and all pages will 188 # contain a <link> tag referring to it. The value of this option must be the 189 # base URL from which the finished HTML is served. 190 #html_use_opensearch = '' 191 192 # This is the file name suffix for HTML files (e.g. ".xhtml"). 193 #html_file_suffix = None 194 195 # Output file base name for HTML help builder. 196 htmlhelp_basename = 'deisdoc' 197 198 199 # -- Options for LaTeX output -------------------------------------------------- 200 201 latex_elements = { 202 # The paper size ('letterpaper' or 'a4paper'). 203 #'papersize': 'letterpaper', 204 205 # The font size ('10pt', '11pt' or '12pt'). 206 #'pointsize': '10pt', 207 208 # Additional stuff for the LaTeX preamble. 209 #'preamble': '', 210 } 211 212 # Grouping the document tree into LaTeX files. List of tuples 213 # (source start file, target name, title, author, documentclass [howto/manual]). 214 latex_documents = [ 215 ('index', 'deis.tex', u'deis Documentation', 216 u'Author', 'manual'), 217 ] 218 219 # The name of an image file (relative to this directory) to place at the top of 220 # the title page. 221 #latex_logo = None 222 223 # For "manual" documents, if this is true, then toplevel headings are parts, 224 # not chapters. 225 #latex_use_parts = False 226 227 # If true, show page references after internal links. 228 #latex_show_pagerefs = False 229 230 # If true, show URL addresses after external links. 231 #latex_show_urls = False 232 233 # Documents to append as an appendix to all manuals. 234 #latex_appendices = [] 235 236 # If false, no module index is generated. 237 #latex_domain_indices = True 238 239 240 # -- Options for manual page output -------------------------------------------- 241 242 # One entry per manual page. List of tuples 243 # (source start file, name, description, authors, manual section). 244 man_pages = [ 245 ('index', 'deis', u'deis Documentation', 246 [u'Author'], 1) 247 ] 248 249 # If true, show URL addresses after external links. 250 #man_show_urls = False 251 252 253 # -- Options for Texinfo output ------------------------------------------------ 254 255 # Grouping the document tree into Texinfo files. List of tuples 256 # (source start file, target name, title, author, 257 # dir menu entry, description, category) 258 texinfo_documents = [ 259 ('index', 'deis', u'deis Documentation', 260 u'Author', 'deis', 'One line description of project.', 261 'Miscellaneous'), 262 ] 263 264 # Documents to append as an appendix to all manuals. 265 #texinfo_appendices = [] 266 267 # If false, no module index is generated. 268 #texinfo_domain_indices = True 269 270 # How to display URL addresses: 'footnote', 'no', or 'inline'. 271 #texinfo_show_urls = 'footnote' 272 273 # If true, do not generate a @detailmenu in the "Top" node's menu. 274 #texinfo_no_detailmenu = False 275 276 277 # -- Options for Epub output --------------------------------------------------- 278 279 # Bibliographic Dublin Core info. 280 epub_title = u'deis' 281 epub_author = u'Engine Yard, Inc.' 282 epub_publisher = u'Engine Yard, Inc.' 283 epub_copyright = u'2013, Engine Yard, Inc.' 284 285 # The language of the text. It defaults to the language option 286 # or en if the language is not set. 287 #epub_language = '' 288 289 # The scheme of the identifier. Typical schemes are ISBN or URL. 290 #epub_scheme = '' 291 292 # The unique identifier of the text. This can be a ISBN number 293 # or the project homepage. 294 #epub_identifier = '' 295 296 # A unique identification for the text. 297 #epub_uid = '' 298 299 # A tuple containing the cover image and cover page html template filenames. 300 #epub_cover = () 301 302 # A sequence of (type, uri, title) tuples for the guide element of content.opf. 303 #epub_guide = () 304 305 # HTML files that should be inserted before the pages created by sphinx. 306 # The format is a list of tuples containing the path and title. 307 #epub_pre_files = [] 308 309 # HTML files shat should be inserted after the pages created by sphinx. 310 # The format is a list of tuples containing the path and title. 311 #epub_post_files = [] 312 313 # A list of files that should not be packed into the epub file. 314 #epub_exclude_files = [] 315 316 # The depth of the table of contents in toc.ncx. 317 #epub_tocdepth = 3 318 319 # Allow duplicate toc entries. 320 #epub_tocdup = True 321 322 # Fix unsupported image types using the PIL. 323 #epub_fix_images = False 324 325 # Scale large images. 326 #epub_max_image_width = 0 327 328 # If 'no', URL addresses will not be shown. 329 #epub_show_urls = 'inline' 330 331 # If false, no index is generated. 332 #epub_use_index = True