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