github.com/llvm-mirror/llgo@v0.0.0-20190322182713-bf6f0a60fce1/docs/conf.py (about) 1 # -*- coding: utf-8 -*- 2 # 3 # llgo documentation build configuration file, created by 4 # sphinx-quickstart on Sun Apr 5 16:02:16 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 18 # If extensions (or modules to document with autodoc) are in another directory, 19 # add these directories to sys.path here. If the directory is relative to the 20 # documentation root, use os.path.abspath to make it absolute, like shown here. 21 #sys.path.insert(0, os.path.abspath('.')) 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 29 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 30 # ones. 31 extensions = [] 32 33 # Add any paths that contain templates here, relative to this directory. 34 templates_path = ['_templates'] 35 36 # The suffix of source filenames. 37 source_suffix = '.rst' 38 39 # The encoding of source files. 40 #source_encoding = 'utf-8-sig' 41 42 # The master toctree document. 43 master_doc = 'index' 44 45 # General information about the project. 46 project = u'llgo' 47 copyright = u'2015, LLVM Team' 48 49 # The version info for the project you're documenting, acts as replacement for 50 # |version| and |release|, also used in various other places throughout the 51 # built documents. 52 # 53 # The short X.Y version. 54 version = '3.7' 55 # The full version, including alpha/beta/rc tags. 56 release = '3.7' 57 58 # The language for content autogenerated by Sphinx. Refer to documentation 59 # for a list of supported languages. 60 #language = None 61 62 # There are two options for replacing |today|: either, you set today to some 63 # non-false value, then it is used: 64 #today = '' 65 # Else, today_fmt is used as the format for a strftime call. 66 #today_fmt = '%B %d, %Y' 67 68 # List of patterns, relative to source directory, that match files and 69 # directories to ignore when looking for source files. 70 exclude_patterns = ['_build'] 71 72 # The reST default role (used for this markup: `text`) to use for all 73 # documents. 74 #default_role = None 75 76 # If true, '()' will be appended to :func: etc. cross-reference text. 77 #add_function_parentheses = True 78 79 # If true, the current module name will be prepended to all description 80 # unit titles (such as .. function::). 81 #add_module_names = True 82 83 # If true, sectionauthor and moduleauthor directives will be shown in the 84 # output. They are ignored by default. 85 #show_authors = False 86 87 # The name of the Pygments (syntax highlighting) style to use. 88 pygments_style = 'sphinx' 89 90 # A list of ignored prefixes for module index sorting. 91 #modindex_common_prefix = [] 92 93 # If true, keep warnings as "system message" paragraphs in the built documents. 94 #keep_warnings = False 95 96 97 # -- Options for HTML output ---------------------------------------------- 98 99 # The theme to use for HTML and HTML Help pages. See the documentation for 100 # a list of builtin themes. 101 html_theme = 'default' 102 103 # Theme options are theme-specific and customize the look and feel of a theme 104 # further. For a list of options available for each theme, see the 105 # documentation. 106 #html_theme_options = {} 107 108 # Add any paths that contain custom themes here, relative to this directory. 109 #html_theme_path = [] 110 111 # The name for this set of Sphinx documents. If None, it defaults to 112 # "<project> v<release> documentation". 113 #html_title = None 114 115 # A shorter title for the navigation bar. Default is the same as html_title. 116 #html_short_title = None 117 118 # The name of an image file (relative to this directory) to place at the top 119 # of the sidebar. 120 #html_logo = None 121 122 # The name of an image file (within the static path) to use as favicon of the 123 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 124 # pixels large. 125 #html_favicon = None 126 127 # Add any paths that contain custom static files (such as style sheets) here, 128 # relative to this directory. They are copied after the builtin static files, 129 # so a file named "default.css" will overwrite the builtin "default.css". 130 html_static_path = ['_static'] 131 132 # Add any extra paths that contain custom files (such as robots.txt or 133 # .htaccess) here, relative to this directory. These files are copied 134 # directly to the root of the documentation. 135 #html_extra_path = [] 136 137 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 138 # using the given strftime format. 139 #html_last_updated_fmt = '%b %d, %Y' 140 141 # If true, SmartyPants will be used to convert quotes and dashes to 142 # typographically correct entities. 143 #html_use_smartypants = True 144 145 # Custom sidebar templates, maps document names to template names. 146 #html_sidebars = {} 147 148 # Additional templates that should be rendered to pages, maps page names to 149 # template names. 150 #html_additional_pages = {} 151 152 # If false, no module index is generated. 153 #html_domain_indices = True 154 155 # If false, no index is generated. 156 #html_use_index = True 157 158 # If true, the index is split into individual pages for each letter. 159 #html_split_index = False 160 161 # If true, links to the reST sources are added to the pages. 162 #html_show_sourcelink = True 163 164 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 165 #html_show_sphinx = True 166 167 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 168 #html_show_copyright = True 169 170 # If true, an OpenSearch description file will be output, and all pages will 171 # contain a <link> tag referring to it. The value of this option must be the 172 # base URL from which the finished HTML is served. 173 #html_use_opensearch = '' 174 175 # This is the file name suffix for HTML files (e.g. ".xhtml"). 176 #html_file_suffix = None 177 178 # Output file base name for HTML help builder. 179 htmlhelp_basename = 'llgodoc' 180 181 182 # -- Options for LaTeX output --------------------------------------------- 183 184 latex_elements = { 185 # The paper size ('letterpaper' or 'a4paper'). 186 #'papersize': 'letterpaper', 187 188 # The font size ('10pt', '11pt' or '12pt'). 189 #'pointsize': '10pt', 190 191 # Additional stuff for the LaTeX preamble. 192 #'preamble': '', 193 } 194 195 # Grouping the document tree into LaTeX files. List of tuples 196 # (source start file, target name, title, 197 # author, documentclass [howto, manual, or own class]). 198 latex_documents = [ 199 ('index', 'llgo.tex', u'llgo Documentation', 200 u'LLVM Team', 'manual'), 201 ] 202 203 # The name of an image file (relative to this directory) to place at the top of 204 # the title page. 205 #latex_logo = None 206 207 # For "manual" documents, if this is true, then toplevel headings are parts, 208 # not chapters. 209 #latex_use_parts = False 210 211 # If true, show page references after internal links. 212 #latex_show_pagerefs = False 213 214 # If true, show URL addresses after external links. 215 #latex_show_urls = False 216 217 # Documents to append as an appendix to all manuals. 218 #latex_appendices = [] 219 220 # If false, no module index is generated. 221 #latex_domain_indices = True 222 223 224 # -- Options for manual page output --------------------------------------- 225 226 # One entry per manual page. List of tuples 227 # (source start file, name, description, authors, manual section). 228 man_pages = [ 229 ('index', 'llgo', u'llgo Documentation', 230 [u'LLVM Team'], 1) 231 ] 232 233 # If true, show URL addresses after external links. 234 #man_show_urls = False 235 236 237 # -- Options for Texinfo output ------------------------------------------- 238 239 # Grouping the document tree into Texinfo files. List of tuples 240 # (source start file, target name, title, author, 241 # dir menu entry, description, category) 242 texinfo_documents = [ 243 ('index', 'llgo', u'llgo Documentation', 244 u'LLVM Team', 'llgo', 'One line description of project.', 245 'Miscellaneous'), 246 ] 247 248 # Documents to append as an appendix to all manuals. 249 #texinfo_appendices = [] 250 251 # If false, no module index is generated. 252 #texinfo_domain_indices = True 253 254 # How to display URL addresses: 'footnote', 'no', or 'inline'. 255 #texinfo_show_urls = 'footnote' 256 257 # If true, do not generate a @detailmenu in the "Top" node's menu. 258 #texinfo_no_detailmenu = False