110ff414cSEd Maste# -*- coding: utf-8 -*- 210ff414cSEd Maste# 310ff414cSEd Maste# libcbor documentation build configuration file, created by 410ff414cSEd Maste# sphinx-quickstart on Sun Jun 8 13:27:19 2014. 510ff414cSEd Maste# 610ff414cSEd Maste# This file is execfile()d with the current directory set to its 710ff414cSEd Maste# containing dir. 810ff414cSEd Maste# 910ff414cSEd Maste# Note that not all possible configuration values are present in this 1010ff414cSEd Maste# autogenerated file. 1110ff414cSEd Maste# 1210ff414cSEd Maste# All configuration values have a default; values that are commented out 1310ff414cSEd Maste# serve to show the default. 1410ff414cSEd Maste 1510ff414cSEd Masteimport sys 1610ff414cSEd Masteimport os 1710ff414cSEd Maste 1810ff414cSEd Maste# If extensions (or modules to document with autodoc) are in another directory, 1910ff414cSEd Maste# add these directories to sys.path here. If the directory is relative to the 2010ff414cSEd Maste# documentation root, use os.path.abspath to make it absolute, like shown here. 2110ff414cSEd Maste#sys.path.insert(0, os.path.abspath('.')) 2210ff414cSEd Mastesys.path.append(os.path.abspath(os.path.dirname(__file__))) 2310ff414cSEd Maste 2410ff414cSEd Maste# -- General configuration ------------------------------------------------ 2510ff414cSEd Maste 2610ff414cSEd Maste# If your documentation needs a minimal Sphinx version, state it here. 2710ff414cSEd Maste#needs_sphinx = '1.0' 2810ff414cSEd Maste 2910ff414cSEd Maste# Add any Sphinx extension module names here, as strings. They can be 3010ff414cSEd Maste# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 3110ff414cSEd Maste# ones. 3210ff414cSEd Masteextensions = [ 3310ff414cSEd Maste 'breathe', 3410ff414cSEd Maste 'sphinx.ext.mathjax', 3510ff414cSEd Maste 'sphinx.ext.autodoc', 36*abd87254SEd Maste 'sphinx.ext.ifconfig', 37*abd87254SEd Maste 'sphinx_rtd_theme' 3810ff414cSEd Maste] 3910ff414cSEd Maste 4010ff414cSEd Masteimport subprocess, os 4110ff414cSEd Maste 4210ff414cSEd Maste# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org 4310ff414cSEd Masteon_rtd = os.environ.get('READTHEDOCS', None) == 'True' 4410ff414cSEd Masteprint(subprocess.check_output('cd ../..; mkdir doc/build; doxygen', shell=True)) 4510ff414cSEd Maste 4610ff414cSEd Masteif on_rtd: 4710ff414cSEd Maste print(subprocess.check_output('cd ../..; mkdir doc/build; doxygen', shell=True)) 4810ff414cSEd Maste 4910ff414cSEd Maste 5010ff414cSEd Masteprint(os.getcwd()) 5110ff414cSEd Masteprint(os.getcwd() + '/../build/doxygen/xml') 5210ff414cSEd Maste 5310ff414cSEd Mastebreathe_projects = { 5410ff414cSEd Maste 'libcbor': '../build/doxygen/xml' 5510ff414cSEd Maste} 5610ff414cSEd Maste 5710ff414cSEd Mastebreathe_default_project = "libcbor" 5810ff414cSEd Maste 5910ff414cSEd Maste# Add any paths that contain templates here, relative to this directory. 6010ff414cSEd Mastetemplates_path = ['_templates'] 6110ff414cSEd Maste 6210ff414cSEd Maste# The suffix of source filenames. 6310ff414cSEd Mastesource_suffix = '.rst' 6410ff414cSEd Maste 6510ff414cSEd Maste# The encoding of source files. 6610ff414cSEd Maste#source_encoding = 'utf-8-sig' 6710ff414cSEd Maste 6810ff414cSEd Maste# The master toctree document. 6910ff414cSEd Mastemaster_doc = 'index' 7010ff414cSEd Maste 7110ff414cSEd Maste# General information about the project. 7210ff414cSEd Masteproject = 'libcbor' 7310ff414cSEd Mastecopyright = '2014 - 2020, Pavel Kalvoda' 7410ff414cSEd Maste 7510ff414cSEd Maste# The version info for the project you're documenting, acts as replacement for 7610ff414cSEd Maste# |version| and |release|, also used in various other places throughout the 7710ff414cSEd Maste# built documents. 7810ff414cSEd Maste# 7910ff414cSEd Maste# The short X.Y version. 80*abd87254SEd Masteversion = '0.11' 81*abd87254SEd Masterelease = '0.11.0' 8210ff414cSEd Maste 8310ff414cSEd Maste# The language for content autogenerated by Sphinx. Refer to documentation 8410ff414cSEd Maste# for a list of supported languages. 8510ff414cSEd Maste#language = None 8610ff414cSEd Maste 8710ff414cSEd Maste# There are two options for replacing |today|: either, you set today to some 8810ff414cSEd Maste# non-false value, then it is used: 8910ff414cSEd Maste#today = '' 9010ff414cSEd Maste# Else, today_fmt is used as the format for a strftime call. 9110ff414cSEd Maste#today_fmt = '%B %d, %Y' 9210ff414cSEd Maste 9310ff414cSEd Maste# List of patterns, relative to source directory, that match files and 9410ff414cSEd Maste# directories to ignore when looking for source files. 9510ff414cSEd Maste# https://github.com/michaeljones/breathe/issues/197 9610ff414cSEd Masteexclude_patterns = ['breathe/*'] 9710ff414cSEd Maste 9810ff414cSEd Maste# The reST default role (used for this markup: `text`) to use for all 9910ff414cSEd Maste# documents. 10010ff414cSEd Mastebreathe_domain_by_extension = { 10110ff414cSEd Maste "h" : "C", 10210ff414cSEd Maste } 10310ff414cSEd Maste#default_role = 'c:func' 10410ff414cSEd Masteprimary_domain = "cpp" 10510ff414cSEd Maste 10610ff414cSEd Maste# If true, '()' will be appended to :func: etc. cross-reference text. 10710ff414cSEd Masteadd_function_parentheses = True 10810ff414cSEd Maste 10910ff414cSEd Maste# If true, the current module name will be prepended to all description 11010ff414cSEd Maste# unit titles (such as .. function::). 11110ff414cSEd Maste#add_module_names = True 11210ff414cSEd Maste 11310ff414cSEd Maste# If true, sectionauthor and moduleauthor directives will be shown in the 11410ff414cSEd Maste# output. They are ignored by default. 11510ff414cSEd Maste#show_authors = False 11610ff414cSEd Maste 11710ff414cSEd Maste# The name of the Pygments (syntax highlighting) style to use. 11810ff414cSEd Mastepygments_style = 'sphinx' 11910ff414cSEd Maste 12010ff414cSEd Maste# A list of ignored prefixes for module index sorting. 12110ff414cSEd Maste#modindex_common_prefix = [] 12210ff414cSEd Maste 12310ff414cSEd Maste# If true, keep warnings as "system message" paragraphs in the built documents. 12410ff414cSEd Maste#keep_warnings = False 12510ff414cSEd Maste 12610ff414cSEd Maste 12710ff414cSEd Maste# -- Options for HTML output ---------------------------------------------- 12810ff414cSEd Maste 12910ff414cSEd Maste# The theme to use for HTML and HTML Help pages. See the documentation for 13010ff414cSEd Maste# a list of builtin themes. 131*abd87254SEd Mastehtml_theme = 'sphinx_rtd_theme' 13210ff414cSEd Maste 13310ff414cSEd Maste# Theme options are theme-specific and customize the look and feel of a theme 13410ff414cSEd Maste# further. For a list of options available for each theme, see the 13510ff414cSEd Maste# documentation. 13610ff414cSEd Maste#html_theme_options = {} 13710ff414cSEd Maste 13810ff414cSEd Maste# Add any paths that contain custom themes here, relative to this directory. 13910ff414cSEd Maste#html_theme_path = [] 14010ff414cSEd Maste 14110ff414cSEd Maste# The name for this set of Sphinx documents. If None, it defaults to 14210ff414cSEd Maste# "<project> v<release> documentation". 14310ff414cSEd Maste#html_title = None 14410ff414cSEd Maste 14510ff414cSEd Maste# A shorter title for the navigation bar. Default is the same as html_title. 14610ff414cSEd Maste#html_short_title = None 14710ff414cSEd Maste 14810ff414cSEd Maste# The name of an image file (relative to this directory) to place at the top 14910ff414cSEd Maste# of the sidebar. 15010ff414cSEd Maste#html_logo = None 15110ff414cSEd Maste 15210ff414cSEd Maste# The name of an image file (within the static path) to use as favicon of the 15310ff414cSEd Maste# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 15410ff414cSEd Maste# pixels large. 15510ff414cSEd Maste#html_favicon = None 15610ff414cSEd Maste 15710ff414cSEd Maste# Add any paths that contain custom static files (such as style sheets) here, 15810ff414cSEd Maste# relative to this directory. They are copied after the builtin static files, 15910ff414cSEd Maste# so a file named "default.css" will overwrite the builtin "default.css". 16010ff414cSEd Mastehtml_static_path = [] 16110ff414cSEd Maste 16210ff414cSEd Maste# Add any extra paths that contain custom files (such as robots.txt or 16310ff414cSEd Maste# .htaccess) here, relative to this directory. These files are copied 16410ff414cSEd Maste# directly to the root of the documentation. 16510ff414cSEd Maste#html_extra_path = [] 16610ff414cSEd Maste 16710ff414cSEd Maste# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 16810ff414cSEd Maste# using the given strftime format. 16910ff414cSEd Maste#html_last_updated_fmt = '%b %d, %Y' 17010ff414cSEd Maste 17110ff414cSEd Maste# If true, SmartyPants will be used to convert quotes and dashes to 17210ff414cSEd Maste# typographically correct entities. 17310ff414cSEd Maste#html_use_smartypants = True 17410ff414cSEd Maste 17510ff414cSEd Maste# Custom sidebar templates, maps document names to template names. 17610ff414cSEd Maste#html_sidebars = {} 17710ff414cSEd Maste 17810ff414cSEd Maste# Additional templates that should be rendered to pages, maps page names to 17910ff414cSEd Maste# template names. 18010ff414cSEd Maste#html_additional_pages = {} 18110ff414cSEd Maste 18210ff414cSEd Maste# If false, no module index is generated. 18310ff414cSEd Maste#html_domain_indices = True 18410ff414cSEd Maste 18510ff414cSEd Maste# If false, no index is generated. 18610ff414cSEd Maste#html_use_index = True 18710ff414cSEd Maste 18810ff414cSEd Maste# If true, the index is split into individual pages for each letter. 18910ff414cSEd Maste#html_split_index = False 19010ff414cSEd Maste 19110ff414cSEd Maste# If true, links to the reST sources are added to the pages. 19210ff414cSEd Maste#html_show_sourcelink = True 19310ff414cSEd Maste 19410ff414cSEd Maste# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 19510ff414cSEd Maste#html_show_sphinx = True 19610ff414cSEd Maste 19710ff414cSEd Maste# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 19810ff414cSEd Maste#html_show_copyright = True 19910ff414cSEd Maste 20010ff414cSEd Maste# If true, an OpenSearch description file will be output, and all pages will 20110ff414cSEd Maste# contain a <link> tag referring to it. The value of this option must be the 20210ff414cSEd Maste# base URL from which the finished HTML is served. 20310ff414cSEd Maste#html_use_opensearch = '' 20410ff414cSEd Maste 20510ff414cSEd Maste# This is the file name suffix for HTML files (e.g. ".xhtml"). 20610ff414cSEd Maste#html_file_suffix = None 20710ff414cSEd Maste 20810ff414cSEd Maste# Output file base name for HTML help builder. 20910ff414cSEd Mastehtmlhelp_basename = 'libcbordoc' 21010ff414cSEd Maste 21110ff414cSEd Maste 21210ff414cSEd Maste# -- Options for LaTeX output --------------------------------------------- 21310ff414cSEd Maste 21410ff414cSEd Mastelatex_elements = { 21510ff414cSEd Maste# The paper size ('letterpaper' or 'a4paper'). 21610ff414cSEd Maste#'papersize': 'letterpaper', 21710ff414cSEd Maste 21810ff414cSEd Maste# The font size ('10pt', '11pt' or '12pt'). 21910ff414cSEd Maste#'pointsize': '10pt', 22010ff414cSEd Maste 22110ff414cSEd Maste# Additional stuff for the LaTeX preamble. 22210ff414cSEd Maste#'preamble': '', 22310ff414cSEd Maste} 22410ff414cSEd Maste 22510ff414cSEd Maste# Grouping the document tree into LaTeX files. List of tuples 22610ff414cSEd Maste# (source start file, target name, title, 22710ff414cSEd Maste# author, documentclass [howto, manual, or own class]). 22810ff414cSEd Mastelatex_documents = [ 22910ff414cSEd Maste ('index', 'libcbor.tex', 'libcbor Documentation', 23010ff414cSEd Maste 'Pavel Kalvoda', 'manual'), 23110ff414cSEd Maste] 23210ff414cSEd Maste 23310ff414cSEd Maste# The name of an image file (relative to this directory) to place at the top of 23410ff414cSEd Maste# the title page. 23510ff414cSEd Maste#latex_logo = None 23610ff414cSEd Maste 23710ff414cSEd Maste# For "manual" documents, if this is true, then toplevel headings are parts, 23810ff414cSEd Maste# not chapters. 23910ff414cSEd Maste#latex_use_parts = False 24010ff414cSEd Maste 24110ff414cSEd Maste# If true, show page references after internal links. 24210ff414cSEd Maste#latex_show_pagerefs = False 24310ff414cSEd Maste 24410ff414cSEd Maste# If true, show URL addresses after external links. 24510ff414cSEd Maste#latex_show_urls = False 24610ff414cSEd Maste 24710ff414cSEd Maste# Documents to append as an appendix to all manuals. 24810ff414cSEd Maste#latex_appendices = [] 24910ff414cSEd Maste 25010ff414cSEd Maste# If false, no module index is generated. 25110ff414cSEd Maste#latex_domain_indices = True 25210ff414cSEd Maste 25310ff414cSEd Maste 25410ff414cSEd Maste# -- Options for manual page output --------------------------------------- 25510ff414cSEd Maste 25610ff414cSEd Maste# One entry per manual page. List of tuples 25710ff414cSEd Maste# (source start file, name, description, authors, manual section). 25810ff414cSEd Masteman_pages = [ 25910ff414cSEd Maste ('index', 'libcbor', 'libcbor Documentation', 26010ff414cSEd Maste ['Pavel Kalvoda'], 3) 26110ff414cSEd Maste] 26210ff414cSEd Maste 26310ff414cSEd Maste# If true, show URL addresses after external links. 26410ff414cSEd Maste#man_show_urls = False 26510ff414cSEd Maste 26610ff414cSEd Maste 26710ff414cSEd Maste# -- Options for Texinfo output ------------------------------------------- 26810ff414cSEd Maste 26910ff414cSEd Maste# Grouping the document tree into Texinfo files. List of tuples 27010ff414cSEd Maste# (source start file, target name, title, author, 27110ff414cSEd Maste# dir menu entry, description, category) 27210ff414cSEd Mastetexinfo_documents = [ 27310ff414cSEd Maste ('index', 'libcbor', 'libcbor Documentation', 27410ff414cSEd Maste 'Pavel Kalvoda', 'libcbor', 'C library for parsing and generating CBOR.', 27510ff414cSEd Maste 'Miscellaneous'), 27610ff414cSEd Maste] 27710ff414cSEd Maste 27810ff414cSEd Maste# Documents to append as an appendix to all manuals. 27910ff414cSEd Maste#texinfo_appendices = [] 28010ff414cSEd Maste 28110ff414cSEd Maste# If false, no module index is generated. 28210ff414cSEd Maste#texinfo_domain_indices = True 28310ff414cSEd Maste 28410ff414cSEd Maste# How to display URL addresses: 'footnote', 'no', or 'inline'. 28510ff414cSEd Maste#texinfo_show_urls = 'footnote' 28610ff414cSEd Maste 28710ff414cSEd Maste# If true, do not generate a @detailmenu in the "Top" node's menu. 28810ff414cSEd Maste#texinfo_no_detailmenu = False 289