conf.py revision 11986:c12e4625ab56
1#!/usr/bin/env python3 2# -*- coding: utf-8 -*- 3# 4# pybind11 documentation build configuration file, created by 5# sphinx-quickstart on Sun Oct 11 19:23:48 2015. 6# 7# This file is execfile()d with the current directory set to its 8# containing dir. 9# 10# Note that not all possible configuration values are present in this 11# autogenerated file. 12# 13# All configuration values have a default; values that are commented out 14# serve to show the default. 15 16import sys 17import os 18import shlex 19 20# If extensions (or modules to document with autodoc) are in another directory, 21# add these directories to sys.path here. If the directory is relative to the 22# documentation root, use os.path.abspath to make it absolute, like shown here. 23#sys.path.insert(0, os.path.abspath('.')) 24 25# -- General configuration ------------------------------------------------ 26 27# If your documentation needs a minimal Sphinx version, state it here. 28#needs_sphinx = '1.0' 29 30# Add any Sphinx extension module names here, as strings. They can be 31# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 32# ones. 33extensions = [] 34 35# Add any paths that contain templates here, relative to this directory. 36templates_path = ['.templates'] 37 38# The suffix(es) of source filenames. 39# You can specify multiple suffix as a list of string: 40# source_suffix = ['.rst', '.md'] 41source_suffix = '.rst' 42 43# The encoding of source files. 44#source_encoding = 'utf-8-sig' 45 46# The master toctree document. 47master_doc = 'index' 48 49# General information about the project. 50project = 'pybind11' 51copyright = '2015, Wenzel Jakob' 52author = 'Wenzel Jakob' 53 54# The version info for the project you're documenting, acts as replacement for 55# |version| and |release|, also used in various other places throughout the 56# built documents. 57# 58# The short X.Y version. 59version = '1.9' 60# The full version, including alpha/beta/rc tags. 61release = '1.9.dev0' 62 63# The language for content autogenerated by Sphinx. Refer to documentation 64# for a list of supported languages. 65# 66# This is also used if you do content translation via gettext catalogs. 67# Usually you set "language" from the command line for these cases. 68language = None 69 70# There are two options for replacing |today|: either, you set today to some 71# non-false value, then it is used: 72#today = '' 73# Else, today_fmt is used as the format for a strftime call. 74#today_fmt = '%B %d, %Y' 75 76# List of patterns, relative to source directory, that match files and 77# directories to ignore when looking for source files. 78exclude_patterns = ['.build', 'release.rst'] 79 80# The reST default role (used for this markup: `text`) to use for all 81# documents. 82#default_role = None 83 84# If true, '()' will be appended to :func: etc. cross-reference text. 85#add_function_parentheses = True 86 87# If true, the current module name will be prepended to all description 88# unit titles (such as .. function::). 89#add_module_names = True 90 91# If true, sectionauthor and moduleauthor directives will be shown in the 92# output. They are ignored by default. 93#show_authors = False 94 95# The name of the Pygments (syntax highlighting) style to use. 96#pygments_style = 'monokai' 97 98# A list of ignored prefixes for module index sorting. 99#modindex_common_prefix = [] 100 101# If true, keep warnings as "system message" paragraphs in the built documents. 102#keep_warnings = False 103 104# If true, `todo` and `todoList` produce output, else they produce nothing. 105todo_include_todos = False 106 107 108# -- Options for HTML output ---------------------------------------------- 109 110# The theme to use for HTML and HTML Help pages. See the documentation for 111# a list of builtin themes. 112 113on_rtd = os.environ.get('READTHEDOCS', None) == 'True' 114 115if not on_rtd: # only import and set the theme if we're building docs locally 116 import sphinx_rtd_theme 117 html_theme = 'sphinx_rtd_theme' 118 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] 119 120 html_context = { 121 'css_files': [ 122 '_static/theme_overrides.css' 123 ] 124 } 125else: 126 html_context = { 127 'css_files': [ 128 '//media.readthedocs.org/css/sphinx_rtd_theme.css', 129 '//media.readthedocs.org/css/readthedocs-doc-embed.css', 130 '_static/theme_overrides.css' 131 ] 132 } 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". 161html_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', 'h', 'it', 'ja' 212# 'nl', 'no', 'pt', 'ro', 'r', '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. 224htmlhelp_basename = 'pybind11doc' 225 226# -- Options for LaTeX output --------------------------------------------- 227 228latex_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': '\DeclareUnicodeCharacter{00A0}{}', 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]). 245latex_documents = [ 246 (master_doc, 'pybind11.tex', 'pybind11 Documentation', 247 'Wenzel Jakob', '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 = 'pybind11-logo.png' 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). 275man_pages = [ 276 (master_doc, 'pybind11', 'pybind11 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) 289texinfo_documents = [ 290 (master_doc, 'pybind11', 'pybind11 Documentation', 291 author, 'pybind11', '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 307primary_domain = 'cpp' 308highlight_language = 'cpp' 309