254 lines · python
1# -*- coding: utf-8 -*-2# ORC-RT 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 14# If extensions (or modules to document with autodoc) are in another directory,15# add these directories to sys.path here. If the directory is relative to the16# documentation root, use os.path.abspath to make it absolute, like shown here.17# sys.path.insert(0, os.path.abspath('.'))18 19# -- General configuration -----------------------------------------------------20 21# If your documentation needs a minimal Sphinx version, state it here.22# needs_sphinx = '1.0'23# Add any Sphinx extension module names here, as strings. They can be extensions24# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.25extensions = [26 "sphinx.ext.todo",27 "sphinx.ext.mathjax",28 "sphinx.ext.intersphinx",29 "sphinx.ext.autodoc",30]31 32# When building man pages, we do not use the markdown pages,33# So, we can continue without the myst_parser dependencies.34# Doing so reduces dependencies of some packaged llvm distributions.35try:36 import myst_parser37 38 extensions.append("myst_parser")39except ImportError:40 if not tags.has("builder-man"):41 raise42 43 44# Add any paths that contain templates here, relative to this directory.45templates_path = ["_templates"]46myst_heading_anchors = 647 48import sphinx49 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 = "ORC-RT"58copyright = "2025-%d, The ORC-RT Team" % date.today().year59 60# The version info for the project you're documenting, acts as replacement for61# |version| and |release|, also used in various other places throughout the62# built documents. These are currently set to zero because we don't use them.63# Should somebody consider in the future to change them, they need to be updated64# everytime a new release comes out.65#66# The short version.67# version = '0'68# The full version, including alpha/beta/rc tags.69# release = '0'70 71# The language for content autogenerated by Sphinx. Refer to documentation72# for a list of supported languages.73# language = None74 75# There are two options for replacing |today|: either, you set today to some76# non-false value, then it is used:77# today = ''78# Else, today_fmt is used as the format for a strftime call.79# today_fmt = '%B %d, %Y'80 81# List of patterns, relative to source directory, that match files and82# directories to ignore when looking for source files.83exclude_patterns = ["_build", "analyzer", "FIR/*"]84 85# The reST default role (used for this markup: `text`) to use for all documents.86# default_role = None87 88# If true, '()' will be appended to :func: etc. cross-reference text.89# add_function_parentheses = True90 91# If true, the current module name will be prepended to all description92# unit titles (such as .. function::).93# add_module_names = True94 95# If true, sectionauthor and moduleauthor directives will be shown in the96# output. They are ignored by default.97# show_authors = False98 99# The name of the Pygments (syntax highlighting) style to use.100pygments_style = "friendly"101 102# A list of ignored prefixes for module index sorting.103# modindex_common_prefix = []104 105 106# -- Options for HTML output ---------------------------------------------------107 108# The theme to use for HTML and HTML Help pages. See the documentation for109# a list of builtin themes.110html_theme = "haiku"111 112# Theme options are theme-specific and customize the look and feel of a theme113# further. For a list of options available for each theme, see the114# documentation.115# html_theme_options = {}116 117# Add any paths that contain custom themes here, relative to this directory.118# html_theme_path = []119 120# The name for this set of Sphinx documents. If None, it defaults to121# "<project> v<release> documentation".122html_title = "ORC Runtime"123 124# A shorter title for the navigation bar. Default is the same as html_title.125# html_short_title = None126 127# The name of an image file (relative to this directory) to place at the top128# of the sidebar.129# html_logo = None130 131# The name of an image file (within the static path) to use as favicon of the132# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32133# pixels large.134# html_favicon = None135 136# Add any paths that contain custom static files (such as style sheets) here,137# relative to this directory. They are copied after the builtin static files,138# so a file named "default.css" will overwrite the builtin "default.css".139# html_static_path = []140 141# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,142# using the given strftime format.143html_last_updated_fmt = "%b %d, %Y"144 145# If true, SmartyPants will be used to convert quotes and dashes to146# typographically correct entities.147# html_use_smartypants = True148 149# Custom sidebar templates, maps document names to template names.150# html_sidebars = {}151 152# Additional templates that should be rendered to pages, maps page names to153# template names.154# html_additional_pages = {}155 156# If false, no module index is generated.157# html_domain_indices = True158 159# If false, no index is generated.160# html_use_index = True161 162# If true, the index is split into individual pages for each letter.163# html_split_index = False164 165# If true, links to the reST sources are added to the pages.166# html_show_sourcelink = True167 168# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.169# html_show_sphinx = True170 171# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.172# html_show_copyright = True173 174# If true, an OpenSearch description file will be output, and all pages will175# contain a <link> tag referring to it. The value of this option must be the176# base URL from which the finished HTML is served.177# html_use_opensearch = ''178 179# This is the file name suffix for HTML files (e.g. ".xhtml").180# html_file_suffix = None181 182# Output file base name for HTML help builder.183htmlhelp_basename = "orc-rt-doc"184 185# If true, the reST sources are included in the HTML build as186# _sources/name. The default is True.187html_copy_source = False188 189# -- Options for LaTeX output --------------------------------------------------190 191latex_elements = {192 # The paper size ('letterpaper' or 'a4paper').193 #'papersize': 'letterpaper',194 # The font size ('10pt', '11pt' or '12pt').195 #'pointsize': '10pt',196 # Additional stuff for the LaTeX preamble.197 #'preamble': '',198}199 200# Grouping the document tree into LaTeX files. List of tuples201# (source start file, target name, title, author, documentclass [howto/manual]).202latex_documents = [203 ("Overview", "ORC-RT.tex", "orc-rt Documentation", "The orc-rt Team", "manual"),204]205 206# The name of an image file (relative to this directory) to place at the top of207# the title page.208# latex_logo = None209 210# For "manual" documents, if this is true, then toplevel headings are parts,211# not chapters.212# latex_use_parts = False213 214# If true, show page references after internal links.215# latex_show_pagerefs = False216 217# If true, show URL addresses after external links.218# latex_show_urls = False219 220# Documents to append as an appendix to all manuals.221# latex_appendices = []222 223# If false, no module index is generated.224# latex_domain_indices = True225 226 227# -- Options for manual page output --------------------------------------------228 229# One entry per manual page. List of tuples230# (source start file, name, description, authors, manual section).231man_pages = []232 233# If true, show URL addresses after external links.234# man_show_urls = False235 236 237# -- Options for Texinfo output ------------------------------------------------238 239# Grouping the document tree into Texinfo files. List of tuples240# (source start file, target name, title, author,241# dir menu entry, description, category)242texinfo_documents = [243 ("Overview"),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