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