266 lines · python
1# -*- coding: utf-8 -*-2#3# libc documentation build configuration file.4#5# This file is execfile()d with the current directory set to its containing dir.6#7# Note that not all possible configuration values are present in this8# autogenerated file.9#10# All configuration values have a default; values that are commented out11# serve to show the default.12 13import sys, os14from datetime import date15 16# If extensions (or modules to document with autodoc) are in another directory,17# add these directories to sys.path here. If the directory is relative to the18# documentation root, use os.path.abspath to make it absolute, like shown here.19# sys.path.insert(0, os.path.abspath('.'))20 21# -- General configuration -----------------------------------------------------22 23# If your documentation needs a minimal Sphinx version, state it here.24# needs_sphinx = '1.0'25 26# Add any Sphinx extension module names here, as strings. They can be extensions27# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.28extensions = ["sphinx.ext.intersphinx", "sphinx.ext.todo", "sphinx_reredirects"]29 30# Add any paths that contain templates here, relative to this directory.31templates_path = ["_templates"]32 33# The suffix of source filenames.34source_suffix = ".rst"35 36# The encoding of source files.37# source_encoding = 'utf-8-sig'38 39# The master toctree document.40master_doc = "index"41 42# General information about the project.43project = "libc"44copyright = "2011-%d, LLVM Project" % date.today().year45 46# The version info for the project you're documenting, acts as replacement for47# |version| and |release|, also used in various other places throughout the48# built documents.49#50# The short X.Y version.51# version = '14.0'52# The full version, including alpha/beta/rc tags.53# release = '14.0'54 55# The language for content autogenerated by Sphinx. Refer to documentation56# for a list of supported languages.57# language = None58 59# There are two options for replacing |today|: either, you set today to some60# non-false value, then it is used:61# today = ''62# Else, today_fmt is used as the format for a strftime call.63today_fmt = "%Y-%m-%d"64 65# List of patterns, relative to source directory, that match files and66# directories to ignore when looking for source files.67exclude_patterns = ["_build", "Helpers"]68 69# The reST default role (used for this markup: `text`) to use for all documents.70# default_role = None71 72# If true, '()' will be appended to :func: etc. cross-reference text.73# add_function_parentheses = True74 75# If true, the current module name will be prepended to all description76# unit titles (such as .. function::).77# add_module_names = True78 79# If true, sectionauthor and moduleauthor directives will be shown in the80# output. They are ignored by default.81show_authors = True82 83# The name of the Pygments (syntax highlighting) style to use.84pygments_style = "friendly"85 86# A list of ignored prefixes for module index sorting.87# modindex_common_prefix = []88 89 90# -- Options for HTML output ---------------------------------------------------91 92# The theme to use for HTML and HTML Help pages. See the documentation for93# a list of builtin themes.94# html_theme = 'haiku'95html_theme = "alabaster"96 97# Theme options are theme-specific and customize the look and feel of a theme98# further. For a list of options available for each theme, see the99# documentation.100html_theme_options = {101 "font_size": "11pt",102 # Don't generate any links to GitHub.103 "github_button": "false",104}105 106# Add any paths that contain custom themes here, relative to this directory.107# html_theme_path = []108 109# The name for this set of Sphinx documents. If None, it defaults to110# "<project> v<release> documentation".111html_title = "The LLVM C Library"112 113# A shorter title for the navigation bar. Default is the same as html_title.114# html_short_title = None115 116# The name of an image file (relative to this directory) to place at the top117# of the sidebar.118# html_logo = None119 120# The name of an image file (within the static path) to use as favicon of the121# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32122# pixels large.123# html_favicon = None124 125# Add any paths that contain custom static files (such as style sheets) here,126# relative to this directory. They are copied after the builtin static files,127# so a file named "default.css" will overwrite the builtin "default.css".128html_static_path = ["_static"]129#130# html_context = {131# 'css_files': [132# '_static/libc.css'133# ],134# }135 136# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,137# using the given strftime format.138# html_last_updated_fmt = '%b %d, %Y'139 140# If true, SmartyPants will be used to convert quotes and dashes to141# typographically correct entities.142# html_use_smartypants = True143 144# Custom sidebar templates, maps document names to template names.145# html_sidebars = {}146 147# Additional templates that should be rendered to pages, maps page names to148# template names.149# html_additional_pages = {}150 151# If false, no module index is generated.152# html_domain_indices = True153 154# If false, no index is generated.155# html_use_index = True156 157# If true, the index is split into individual pages for each letter.158# html_split_index = False159 160# If true, links to the reST sources are added to the pages.161# html_show_sourcelink = True162 163# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.164# html_show_sphinx = True165 166# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.167# html_show_copyright = True168 169# If true, an OpenSearch description file will be output, and all pages will170# contain a <link> tag referring to it. The value of this option must be the171# base URL from which the finished HTML is served.172# html_use_opensearch = ''173 174# This is the file name suffix for HTML files (e.g. ".xhtml").175# html_file_suffix = None176 177# Output file base name for HTML help builder.178htmlhelp_basename = "libcxxdoc"179 180 181# -- Options for LaTeX output --------------------------------------------------182 183latex_elements = {184 # The paper size ('letterpaper' or 'a4paper').185 #'papersize': 'letterpaper',186 # The font size ('10pt', '11pt' or '12pt').187 #'pointsize': '10pt',188 # Additional stuff for the LaTeX preamble.189 #'preamble': '',190}191 192# Grouping the document tree into LaTeX files. List of tuples193# (source start file, target name, title, author, documentclass [howto/manual]).194latex_documents = [195 ("contents", "libcxx.tex", "libcxx Documentation", "LLVM project", "manual"),196]197 198# The name of an image file (relative to this directory) to place at the top of199# the title page.200# latex_logo = None201 202# For "manual" documents, if this is true, then toplevel headings are parts,203# not chapters.204# latex_use_parts = False205 206# If true, show page references after internal links.207# latex_show_pagerefs = False208 209# If true, show URL addresses after external links.210# latex_show_urls = False211 212# Documents to append as an appendix to all manuals.213# latex_appendices = []214 215# If false, no module index is generated.216# latex_domain_indices = True217 218 219# -- Options for manual page output --------------------------------------------220 221# One entry per manual page. List of tuples222# (source start file, name, description, authors, manual section).223man_pages = [("contents", "libc", "libc Documentation", ["LLVM project"], 1)]224 225# If true, show URL addresses after external links.226# man_show_urls = False227 228 229# -- Options for Texinfo output ------------------------------------------------230 231# Grouping the document tree into Texinfo files. List of tuples232# (source start file, target name, title, author,233# dir menu entry, description, category)234texinfo_documents = [235 (236 "contents",237 "libc",238 "libc Documentation",239 "LLVM project",240 "libc",241 "One line description of project.",242 "Miscellaneous",243 ),244]245 246# Documents to append as an appendix to all manuals.247# texinfo_appendices = []248 249# If false, no module index is generated.250# texinfo_domain_indices = True251 252# How to display URL addresses: 'footnote', 'no', or 'inline'.253# texinfo_show_urls = 'footnote'254 255 256# FIXME: Define intersphinx configuration.257intersphinx_mapping = {}258 259 260# -- Options for extensions ----------------------------------------------------261 262# Enable this if you want TODOs to show up in the generated documentation.263todo_include_todos = True264 265redirects = {"math/index": "../headers/math/index.html"}266