271 lines · python
1# -*- coding: utf-8 -*-2# Flang documentation build configuration file.3#4# This file is execfile()d with the current directory set to its containing dir.5#6# Note that not all possible configuration values are present in this7# autogenerated file.8#9# All configuration values have a default; values that are commented out10# serve to show the default.11 12from datetime import date13# If extensions (or modules to document with autodoc) are in another directory,14# add these directories to sys.path here. If the directory is relative to the15# documentation root, use os.path.abspath to make it absolute, like shown here.16# sys.path.insert(0, os.path.abspath('.'))17 18# -- General configuration -----------------------------------------------------19 20# If your documentation needs a minimal Sphinx version, state it here.21# needs_sphinx = '1.0'22# Add any Sphinx extension module names here, as strings. They can be extensions23# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.24extensions = [25 "sphinx.ext.todo",26 "sphinx.ext.mathjax",27 "sphinx.ext.intersphinx",28 "sphinx.ext.autodoc",29]30 31try:32 import myst_parser33 34 extensions.append("myst_parser")35except ImportError:36 raise ImportError(37 "myst_parser is required to build documentation, including man pages."38 )39 40 41# Add any paths that contain templates here, relative to this directory.42templates_path = ["_templates"]43source_suffix = {44 ".rst": "restructuredtext",45 ".md": "markdown",46}47myst_heading_anchors = 648 49import sphinx50 51# The encoding of source files.52# source_encoding = 'utf-8-sig'53 54# The master toctree document.55master_doc = "index"56 57# General information about the project.58project = "Flang"59copyright = "2017-%d, The Flang Team" % date.today().year60 61# The version info for the project you're documenting, acts as replacement for62# |version| and |release|, also used in various other places throughout the63# built documents. These are currently set to zero because we don't use them.64# Should somebody consider in the future to change them, they need to be updated65# everytime a new release comes out.66#67# The short version.68# version = '0'69# The full version, including alpha/beta/rc tags.70# release = '0'71 72# The language for content autogenerated by Sphinx. Refer to documentation73# for a list of supported languages.74# language = None75 76# There are two options for replacing |today|: either, you set today to some77# non-false value, then it is used:78# today = ''79# Else, today_fmt is used as the format for a strftime call.80# today_fmt = '%B %d, %Y'81 82# List of patterns, relative to source directory, that match files and83# directories to ignore when looking for source files.84exclude_patterns = ["_build", "analyzer", "FIR/*"]85 86# The reST default role (used for this markup: `text`) to use for all documents.87# default_role = None88 89# If true, '()' will be appended to :func: etc. cross-reference text.90# add_function_parentheses = True91 92# If true, the current module name will be prepended to all description93# unit titles (such as .. function::).94# add_module_names = True95 96# If true, sectionauthor and moduleauthor directives will be shown in the97# output. They are ignored by default.98# show_authors = False99 100# The name of the Pygments (syntax highlighting) style to use.101pygments_style = "friendly"102 103# A list of ignored prefixes for module index sorting.104# modindex_common_prefix = []105 106 107# -- Options for HTML output ---------------------------------------------------108 109# The theme to use for HTML and HTML Help pages. See the documentation for110# a list of builtin themes.111html_theme = "haiku"112 113# Theme options are theme-specific and customize the look and feel of a theme114# further. For a list of options available for each theme, see the115# documentation.116# html_theme_options = {}117 118# Add any paths that contain custom themes here, relative to this directory.119# html_theme_path = []120 121# The name for this set of Sphinx documents. If None, it defaults to122# "<project> v<release> documentation".123html_title = "The Flang Compiler"124 125# A shorter title for the navigation bar. Default is the same as html_title.126# html_short_title = None127 128# The name of an image file (relative to this directory) to place at the top129# of the sidebar.130# html_logo = None131 132# The name of an image file (within the static path) to use as favicon of the133# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32134# pixels large.135# html_favicon = None136 137# Add any paths that contain custom static files (such as style sheets) here,138# relative to this directory. They are copied after the builtin static files,139# so a file named "default.css" will overwrite the builtin "default.css".140# html_static_path = []141 142# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,143# using the given strftime format.144html_last_updated_fmt = "%b %d, %Y"145 146# If true, SmartyPants will be used to convert quotes and dashes to147# typographically correct entities.148# html_use_smartypants = True149 150# Custom sidebar templates, maps document names to template names.151# html_sidebars = {}152 153# Additional templates that should be rendered to pages, maps page names to154# template names.155# html_additional_pages = {}156 157# If false, no module index is generated.158# html_domain_indices = True159 160# If false, no index is generated.161# html_use_index = True162 163# If true, the index is split into individual pages for each letter.164# html_split_index = False165 166# If true, links to the reST sources are added to the pages.167# html_show_sourcelink = True168 169# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.170# html_show_sphinx = True171 172# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.173# html_show_copyright = True174 175# If true, an OpenSearch description file will be output, and all pages will176# contain a <link> tag referring to it. The value of this option must be the177# base URL from which the finished HTML is served.178# html_use_opensearch = ''179 180# This is the file name suffix for HTML files (e.g. ".xhtml").181# html_file_suffix = None182 183# Output file base name for HTML help builder.184htmlhelp_basename = "Flangdoc"185 186# If true, the reST sources are included in the HTML build as187# _sources/name. The default is True.188html_copy_source = False189 190# -- Options for LaTeX output --------------------------------------------------191 192latex_elements = {193 # The paper size ('letterpaper' or 'a4paper').194 #'papersize': 'letterpaper',195 # The font size ('10pt', '11pt' or '12pt').196 #'pointsize': '10pt',197 # Additional stuff for the LaTeX preamble.198 #'preamble': '',199}200 201# Grouping the document tree into LaTeX files. List of tuples202# (source start file, target name, title, author, documentclass [howto/manual]).203latex_documents = [204 ("Overview", "Flang.tex", "Flang Documentation", "The Flang Team", "manual"),205]206 207# The name of an image file (relative to this directory) to place at the top of208# the title page.209# latex_logo = None210 211# For "manual" documents, if this is true, then toplevel headings are parts,212# not chapters.213# latex_use_parts = False214 215# If true, show page references after internal links.216# latex_show_pagerefs = False217 218# If true, show URL addresses after external links.219# latex_show_urls = False220 221# Documents to append as an appendix to all manuals.222# latex_appendices = []223 224# If false, no module index is generated.225# latex_domain_indices = True226 227 228# -- Options for manual page output --------------------------------------------229 230# One entry per manual page. List of tuples231# (source start file, name, description, authors, manual section).232man_pages = [233 (234 "index",235 "flang",236 "flang - the Flang Fortran compiler",237 ["Flang Contributors"],238 1,239 )240]241 242# If true, show URL addresses after external links.243# man_show_urls = False244 245 246# -- Options for Texinfo output ------------------------------------------------247 248# Grouping the document tree into Texinfo files. List of tuples249# (source start file, target name, title, author,250# dir menu entry, description, category)251texinfo_documents = [252 (253 "Overview",254 "Flang",255 "Flang Documentation",256 "The Flang Team",257 "Flang",258 "A Fortran front end for LLVM.",259 "Miscellaneous",260 ),261]262 263# Documents to append as an appendix to all manuals.264# texinfo_appendices = []265 266# If false, no module index is generated.267# texinfo_domain_indices = True268 269# How to display URL addresses: 'footnote', 'no', or 'inline'.270# texinfo_show_urls = 'footnote'271