294 lines · python
1# -*- coding: utf-8 -*-2#3# Clang documentation build configuration file, created by4# sphinx-quickstart on Sun Dec 9 20:01:55 2012.5#6# This file is execfile()d with the current directory set to its containing dir.7#8# Note that not all possible configuration values are present in this9# autogenerated file.10#11# All configuration values have a default; values that are commented out12# serve to show the default.13 14from __future__ import absolute_import, division, print_function15import sys, os16from datetime import date17 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 the20# documentation root, use os.path.abspath to make it absolute, like shown here.21sys.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 extensions29# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.30extensions = ["sphinx.ext.todo", "sphinx.ext.mathjax", "sphinx.ext.graphviz", "ghlinks"]31 32# Add any paths that contain templates here, relative to this directory.33templates_path = ["_templates"]34 35 36import sphinx37 38# When building man pages, we do not use the markdown pages,39# So, we can continue without the myst_parser dependencies.40# Doing so reduces dependencies of some packaged llvm distributions.41try:42 import myst_parser43 44 extensions.append("myst_parser")45except ImportError:46 if not tags.has("builder-man"):47 raise48 49 50# The encoding of source files.51# source_encoding = 'utf-8-sig'52 53# The master toctree document.54master_doc = "index"55 56# General information about the project.57project = "Clang"58copyright = "2007-%d, The Clang Team" % date.today().year59 60# The language for content autogenerated by Sphinx. Refer to documentation61# for a list of supported languages.62# language = None63 64# There are two options for replacing |today|: either, you set today to some65# non-false value, then it is used:66# today = ''67# Else, today_fmt is used as the format for a strftime call.68# today_fmt = '%B %d, %Y'69 70# List of patterns, relative to source directory, that match files and71# directories to ignore when looking for source files.72exclude_patterns = ["_build"]73 74# The reST default role (used for this markup: `text`) to use for all documents.75# default_role = None76 77# If true, '()' will be appended to :func: etc. cross-reference text.78# add_function_parentheses = True79 80# If true, the current module name will be prepended to all description81# unit titles (such as .. function::).82# add_module_names = True83 84# If true, sectionauthor and moduleauthor directives will be shown in the85# output. They are ignored by default.86# show_authors = False87 88# The name of the Pygments (syntax highlighting) style to use.89pygments_style = "friendly"90 91in_progress_title = "(In-Progress) " if tags.has("PreRelease") else ""92 93rst_epilog = f"""94.. |ReleaseNotesTitle| replace:: {in_progress_title} Release Notes95"""96 97# -- Options for HTML output ---------------------------------------------------98 99# The theme to use for HTML and HTML Help pages. See the documentation for100# a list of builtin themes.101html_theme = "haiku"102 103# Theme options are theme-specific and customize the look and feel of a theme104# further. For a list of options available for each theme, see the105# 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 to112# "<project> v<release> documentation".113# html_title = None114 115# A shorter title for the navigation bar. Default is the same as html_title.116# html_short_title = None117 118# The name of an image file (relative to this directory) to place at the top119# of the sidebar.120# html_logo = None121 122# The name of an image file (within the static path) to use as favicon of the123# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32124# pixels large.125# html_favicon = None126 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".130html_static_path = []131 132# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,133# using the given strftime format.134# html_last_updated_fmt = '%b %d, %Y'135 136# If true, SmartyPants will be used to convert quotes and dashes to137# typographically correct entities.138# html_use_smartypants = True139 140# Custom sidebar templates, maps document names to template names.141# html_sidebars = {}142 143# Additional templates that should be rendered to pages, maps page names to144# template names.145# html_additional_pages = {}146 147# If false, no module index is generated.148# html_domain_indices = True149 150# If false, no index is generated.151# html_use_index = True152 153# If true, the index is split into individual pages for each letter.154# html_split_index = False155 156# If true, links to the reST sources are added to the pages.157# html_show_sourcelink = True158 159# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.160# html_show_sphinx = True161 162# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.163# html_show_copyright = True164 165# If true, an OpenSearch description file will be output, and all pages will166# contain a <link> tag referring to it. The value of this option must be the167# base URL from which the finished HTML is served.168# html_use_opensearch = ''169 170# This is the file name suffix for HTML files (e.g. ".xhtml").171# html_file_suffix = None172 173# Output file base name for HTML help builder.174htmlhelp_basename = "Clangdoc"175 176 177# -- Options for LaTeX output --------------------------------------------------178 179latex_elements = {180 # The paper size ('letterpaper' or 'a4paper').181 #'papersize': 'letterpaper',182 # The font size ('10pt', '11pt' or '12pt').183 #'pointsize': '10pt',184 # Additional stuff for the LaTeX preamble.185 #'preamble': '',186}187 188# Grouping the document tree into LaTeX files. List of tuples189# (source start file, target name, title, author, documentclass [howto/manual]).190latex_documents = [191 ("index", "Clang.tex", "Clang Documentation", "The Clang Team", "manual"),192]193 194# The name of an image file (relative to this directory) to place at the top of195# the title page.196# latex_logo = None197 198# For "manual" documents, if this is true, then toplevel headings are parts,199# not chapters.200# latex_use_parts = False201 202# If true, show page references after internal links.203# latex_show_pagerefs = False204 205# If true, show URL addresses after external links.206# latex_show_urls = False207 208# Documents to append as an appendix to all manuals.209# latex_appendices = []210 211# If false, no module index is generated.212# latex_domain_indices = True213 214 215# -- Options for manual page output --------------------------------------------216 217# One entry per manual page. List of tuples218# (source start file, name, description, authors, manual section).219man_pages = []220 221# Automatically derive the list of man pages from the contents of the command222# guide subdirectory. This was copied from llvm/docs/conf.py.223basedir = os.path.dirname(__file__)224man_page_authors = "Maintained by the Clang / LLVM Team (<http://clang.llvm.org>)"225command_guide_subpath = "CommandGuide"226command_guide_path = os.path.join(basedir, command_guide_subpath)227for name in os.listdir(command_guide_path):228 # Ignore non-ReST files and the index page.229 if not name.endswith(".rst") or name in ("index.rst",):230 continue231 232 # Otherwise, automatically extract the description.233 file_subpath = os.path.join(command_guide_subpath, name)234 with open(os.path.join(command_guide_path, name)) as f:235 title = f.readline().rstrip("\n")236 header = f.readline().rstrip("\n")237 238 if len(header) != len(title):239 print(240 (241 "error: invalid header in %r (does not match title)"242 % (file_subpath,)243 ),244 file=sys.stderr,245 )246 if " - " not in title:247 print(248 (249 (250 "error: invalid title in %r "251 "(expected '<name> - <description>')"252 )253 % (file_subpath,)254 ),255 file=sys.stderr,256 )257 258 # Split the name out of the title.259 name, description = title.split(" - ", 1)260 man_pages.append(261 (file_subpath.replace(".rst", ""), name, description, man_page_authors, 1)262 )263 264 265# If true, show URL addresses after external links.266# man_show_urls = False267 268 269# -- Options for Texinfo output ------------------------------------------------270 271# Grouping the document tree into Texinfo files. List of tuples272# (source start file, target name, title, author,273# dir menu entry, description, category)274texinfo_documents = [275 (276 "index",277 "Clang",278 "Clang Documentation",279 "The Clang Team",280 "Clang",281 "One line description of project.",282 "Miscellaneous",283 ),284]285 286# Documents to append as an appendix to all manuals.287# texinfo_appendices = []288 289# If false, no module index is generated.290# texinfo_domain_indices = True291 292# How to display URL addresses: 'footnote', 'no', or 'inline'.293# texinfo_show_urls = 'footnote'294