conf.py
1 # -*- coding: utf-8 -*- 2 # 3 # letsencrypt-compatibility-test documentation build configuration file, created by 4 # sphinx-quickstart on Sun Oct 18 13:40:53 2015. 5 # 6 # This file is execfile()d with the current directory set to its 7 # containing dir. 8 # 9 # Note that not all possible configuration values are present in this 10 # autogenerated file. 11 # 12 # All configuration values have a default; values that are commented out 13 # serve to show the default. 14 15 import sys 16 import os 17 import shlex 18 19 20 here = os.path.abspath(os.path.dirname(__file__)) 21 22 # If extensions (or modules to document with autodoc) are in another directory, 23 # add these directories to sys.path here. If the directory is relative to the 24 # documentation root, use os.path.abspath to make it absolute, like shown here. 25 sys.path.insert(0, os.path.abspath(os.path.join(here, '..'))) 26 27 # -- General configuration ------------------------------------------------ 28 29 # If your documentation needs a minimal Sphinx version, state it here. 30 needs_sphinx = '1.0' 31 32 # Add any Sphinx extension module names here, as strings. They can be 33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 34 # ones. 35 extensions = [ 36 'sphinx.ext.autodoc', 37 'sphinx.ext.intersphinx', 38 'sphinx.ext.todo', 39 'sphinx.ext.coverage', 40 'sphinx.ext.viewcode', 41 'repoze.sphinx.autointerface', 42 ] 43 44 autodoc_member_order = 'bysource' 45 autodoc_default_flags = ['show-inheritance', 'private-members'] 46 47 # Add any paths that contain templates here, relative to this directory. 48 templates_path = ['_templates'] 49 50 # The suffix(es) of source filenames. 51 # You can specify multiple suffix as a list of string: 52 # source_suffix = ['.rst', '.md'] 53 source_suffix = '.rst' 54 55 # The encoding of source files. 56 #source_encoding = 'utf-8-sig' 57 58 # The master toctree document. 59 master_doc = 'index' 60 61 # General information about the project. 62 project = u'letsencrypt-compatibility-test' 63 copyright = u'2014-2015, Let\'s Encrypt Project' 64 author = u'Let\'s Encrypt Project' 65 66 # The version info for the project you're documenting, acts as replacement for 67 # |version| and |release|, also used in various other places throughout the 68 # built documents. 69 # 70 # The short X.Y version. 71 version = '0' 72 # The full version, including alpha/beta/rc tags. 73 release = '0' 74 75 # The language for content autogenerated by Sphinx. Refer to documentation 76 # for a list of supported languages. 77 # 78 # This is also used if you do content translation via gettext catalogs. 79 # Usually you set "language" from the command line for these cases. 80 language = 'en' 81 82 # There are two options for replacing |today|: either, you set today to some 83 # non-false value, then it is used: 84 #today = '' 85 # Else, today_fmt is used as the format for a strftime call. 86 #today_fmt = '%B %d, %Y' 87 88 # List of patterns, relative to source directory, that match files and 89 # directories to ignore when looking for source files. 90 exclude_patterns = ['_build'] 91 92 # The reST default role (used for this markup: `text`) to use for all 93 # documents. 94 default_role = 'py:obj' 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 # If true, `todo` and `todoList` produce output, else they produce nothing. 117 todo_include_todos = True 118 119 120 # -- Options for HTML output ---------------------------------------------- 121 122 # The theme to use for HTML and HTML Help pages. See the documentation for 123 # a list of builtin themes. 124 125 # http://docs.readthedocs.org/en/latest/theme.html#how-do-i-use-this-locally-and-on-read-the-docs 126 # on_rtd is whether we are on readthedocs.org 127 on_rtd = os.environ.get('READTHEDOCS', None) == 'True' 128 if not on_rtd: # only import and set the theme if we're building docs locally 129 import sphinx_rtd_theme 130 html_theme = 'sphinx_rtd_theme' 131 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] 132 # otherwise, readthedocs.org uses their theme by default, so no need to specify it 133 134 # Theme options are theme-specific and customize the look and feel of a theme 135 # further. For a list of options available for each theme, see the 136 # documentation. 137 #html_theme_options = {} 138 139 # Add any paths that contain custom themes here, relative to this directory. 140 #html_theme_path = [] 141 142 # The name for this set of Sphinx documents. If None, it defaults to 143 # "<project> v<release> documentation". 144 #html_title = None 145 146 # A shorter title for the navigation bar. Default is the same as html_title. 147 #html_short_title = None 148 149 # The name of an image file (relative to this directory) to place at the top 150 # of the sidebar. 151 #html_logo = None 152 153 # The name of an image file (within the static path) to use as favicon of the 154 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 155 # pixels large. 156 #html_favicon = None 157 158 # Add any paths that contain custom static files (such as style sheets) here, 159 # relative to this directory. They are copied after the builtin static files, 160 # so a file named "default.css" will overwrite the builtin "default.css". 161 html_static_path = ['_static'] 162 163 # Add any extra paths that contain custom files (such as robots.txt or 164 # .htaccess) here, relative to this directory. These files are copied 165 # directly to the root of the documentation. 166 #html_extra_path = [] 167 168 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 169 # using the given strftime format. 170 #html_last_updated_fmt = '%b %d, %Y' 171 172 # If true, SmartyPants will be used to convert quotes and dashes to 173 # typographically correct entities. 174 #html_use_smartypants = True 175 176 # Custom sidebar templates, maps document names to template names. 177 #html_sidebars = {} 178 179 # Additional templates that should be rendered to pages, maps page names to 180 # template names. 181 #html_additional_pages = {} 182 183 # If false, no module index is generated. 184 #html_domain_indices = True 185 186 # If false, no index is generated. 187 #html_use_index = True 188 189 # If true, the index is split into individual pages for each letter. 190 #html_split_index = False 191 192 # If true, links to the reST sources are added to the pages. 193 #html_show_sourcelink = True 194 195 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 196 #html_show_sphinx = True 197 198 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 199 #html_show_copyright = True 200 201 # If true, an OpenSearch description file will be output, and all pages will 202 # contain a <link> tag referring to it. The value of this option must be the 203 # base URL from which the finished HTML is served. 204 #html_use_opensearch = '' 205 206 # This is the file name suffix for HTML files (e.g. ".xhtml"). 207 #html_file_suffix = None 208 209 # Language to be used for generating the HTML full-text search index. 210 # Sphinx supports the following languages: 211 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' 212 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' 213 #html_search_language = 'en' 214 215 # A dictionary with options for the search language support, empty by default. 216 # Now only 'ja' uses this config value 217 #html_search_options = {'type': 'default'} 218 219 # The name of a javascript file (relative to the configuration directory) that 220 # implements a search results scorer. If empty, the default will be used. 221 #html_search_scorer = 'scorer.js' 222 223 # Output file base name for HTML help builder. 224 htmlhelp_basename = 'letsencrypt-compatibility-testdoc' 225 226 # -- Options for LaTeX output --------------------------------------------- 227 228 latex_elements = { 229 # The paper size ('letterpaper' or 'a4paper'). 230 #'papersize': 'letterpaper', 231 232 # The font size ('10pt', '11pt' or '12pt'). 233 #'pointsize': '10pt', 234 235 # Additional stuff for the LaTeX preamble. 236 #'preamble': '', 237 238 # Latex figure (float) alignment 239 #'figure_align': 'htbp', 240 } 241 242 # Grouping the document tree into LaTeX files. List of tuples 243 # (source start file, target name, title, 244 # author, documentclass [howto, manual, or own class]). 245 latex_documents = [ 246 (master_doc, 'letsencrypt-compatibility-test.tex', u'letsencrypt-compatibility-test Documentation', 247 u'Let\'s Encrypt Project', 'manual'), 248 ] 249 250 # The name of an image file (relative to this directory) to place at the top of 251 # the title page. 252 #latex_logo = None 253 254 # For "manual" documents, if this is true, then toplevel headings are parts, 255 # not chapters. 256 #latex_use_parts = False 257 258 # If true, show page references after internal links. 259 #latex_show_pagerefs = False 260 261 # If true, show URL addresses after external links. 262 #latex_show_urls = False 263 264 # Documents to append as an appendix to all manuals. 265 #latex_appendices = [] 266 267 # If false, no module index is generated. 268 #latex_domain_indices = True 269 270 271 # -- Options for manual page output --------------------------------------- 272 273 # One entry per manual page. List of tuples 274 # (source start file, name, description, authors, manual section). 275 man_pages = [ 276 (master_doc, 'letsencrypt-compatibility-test', u'letsencrypt-compatibility-test Documentation', 277 [author], 1) 278 ] 279 280 # If true, show URL addresses after external links. 281 #man_show_urls = False 282 283 284 # -- Options for Texinfo output ------------------------------------------- 285 286 # Grouping the document tree into Texinfo files. List of tuples 287 # (source start file, target name, title, author, 288 # dir menu entry, description, category) 289 texinfo_documents = [ 290 (master_doc, 'letsencrypt-compatibility-test', u'letsencrypt-compatibility-test Documentation', 291 author, 'letsencrypt-compatibility-test', 'One line description of project.', 292 'Miscellaneous'), 293 ] 294 295 # Documents to append as an appendix to all manuals. 296 #texinfo_appendices = [] 297 298 # If false, no module index is generated. 299 #texinfo_domain_indices = True 300 301 # How to display URL addresses: 'footnote', 'no', or 'inline'. 302 #texinfo_show_urls = 'footnote' 303 304 # If true, do not generate a @detailmenu in the "Top" node's menu. 305 #texinfo_no_detailmenu = False 306 307 308 intersphinx_mapping = { 309 'python': ('https://docs.python.org/', None), 310 'acme': ('https://acme-python.readthedocs.org', None), 311 'letsencrypt': ('https://letsencrypt.readthedocs.org', None), 312 'letsencrypt-apache': ('https://letsencrypt-apache.readthedocs.org', None), 313 'letsencrypt-nginx': ('https://letsencrypt-nginx.readthedocs.org', None), 314 }