1# -*- coding: utf-8 -*- 2# 3# libcbor documentation build configuration file, created by 4# sphinx-quickstart on Sun Jun 8 13:27:19 2014. 5# 6# This file is execfile()d with the current directory set to its 7# containing dir. 8# 9# Note that not all possible configuration values are present in this 10# autogenerated file. 11# 12# All configuration values have a default; values that are commented out 13# serve to show the default. 14 15import sys 16import os 17 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 the 20# documentation root, use os.path.abspath to make it absolute, like shown here. 21#sys.path.insert(0, os.path.abspath('.')) 22sys.path.append(os.path.abspath(os.path.dirname(__file__))) 23 24# -- General configuration ------------------------------------------------ 25 26# If your documentation needs a minimal Sphinx version, state it here. 27#needs_sphinx = '1.0' 28 29# Add any Sphinx extension module names here, as strings. They can be 30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 31# ones. 32extensions = [ 33 'breathe', 34 'sphinx.ext.mathjax', 35 'sphinx.ext.autodoc', 36 'sphinx.ext.ifconfig', 37 'sphinx_rtd_theme' 38] 39 40import subprocess, os 41 42# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org 43on_rtd = os.environ.get('READTHEDOCS', None) == 'True' 44print(subprocess.check_output('cd ../..; mkdir doc/build; doxygen', shell=True)) 45 46if on_rtd: 47 print(subprocess.check_output('cd ../..; mkdir doc/build; doxygen', shell=True)) 48 49 50print(os.getcwd()) 51print(os.getcwd() + '/../build/doxygen/xml') 52 53breathe_projects = { 54 'libcbor': '../build/doxygen/xml' 55} 56 57breathe_default_project = "libcbor" 58 59# Add any paths that contain templates here, relative to this directory. 60templates_path = ['_templates'] 61 62# The suffix of source filenames. 63source_suffix = '.rst' 64 65# The encoding of source files. 66#source_encoding = 'utf-8-sig' 67 68# The master toctree document. 69master_doc = 'index' 70 71# General information about the project. 72project = 'libcbor' 73copyright = '2014 - 2020, Pavel Kalvoda' 74 75# The version info for the project you're documenting, acts as replacement for 76# |version| and |release|, also used in various other places throughout the 77# built documents. 78# 79# The short X.Y version. 80version = '0.11' 81release = '0.11.0' 82 83# The language for content autogenerated by Sphinx. Refer to documentation 84# for a list of supported languages. 85#language = None 86 87# There are two options for replacing |today|: either, you set today to some 88# non-false value, then it is used: 89#today = '' 90# Else, today_fmt is used as the format for a strftime call. 91#today_fmt = '%B %d, %Y' 92 93# List of patterns, relative to source directory, that match files and 94# directories to ignore when looking for source files. 95# https://github.com/michaeljones/breathe/issues/197 96exclude_patterns = ['breathe/*'] 97 98# The reST default role (used for this markup: `text`) to use for all 99# documents. 100breathe_domain_by_extension = { 101 "h" : "C", 102 } 103#default_role = 'c:func' 104primary_domain = "cpp" 105 106# If true, '()' will be appended to :func: etc. cross-reference text. 107add_function_parentheses = True 108 109# If true, the current module name will be prepended to all description 110# unit titles (such as .. function::). 111#add_module_names = True 112 113# If true, sectionauthor and moduleauthor directives will be shown in the 114# output. They are ignored by default. 115#show_authors = False 116 117# The name of the Pygments (syntax highlighting) style to use. 118pygments_style = 'sphinx' 119 120# A list of ignored prefixes for module index sorting. 121#modindex_common_prefix = [] 122 123# If true, keep warnings as "system message" paragraphs in the built documents. 124#keep_warnings = False 125 126 127# -- Options for HTML output ---------------------------------------------- 128 129# The theme to use for HTML and HTML Help pages. See the documentation for 130# a list of builtin themes. 131html_theme = 'sphinx_rtd_theme' 132 133# Theme options are theme-specific and customize the look and feel of a theme 134# further. For a list of options available for each theme, see the 135# documentation. 136#html_theme_options = {} 137 138# Add any paths that contain custom themes here, relative to this directory. 139#html_theme_path = [] 140 141# The name for this set of Sphinx documents. If None, it defaults to 142# "<project> v<release> documentation". 143#html_title = None 144 145# A shorter title for the navigation bar. Default is the same as html_title. 146#html_short_title = None 147 148# The name of an image file (relative to this directory) to place at the top 149# of the sidebar. 150#html_logo = None 151 152# The name of an image file (within the static path) to use as favicon of the 153# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 154# pixels large. 155#html_favicon = None 156 157# Add any paths that contain custom static files (such as style sheets) here, 158# relative to this directory. They are copied after the builtin static files, 159# so a file named "default.css" will overwrite the builtin "default.css". 160html_static_path = [] 161 162# Add any extra paths that contain custom files (such as robots.txt or 163# .htaccess) here, relative to this directory. These files are copied 164# directly to the root of the documentation. 165#html_extra_path = [] 166 167# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 168# using the given strftime format. 169#html_last_updated_fmt = '%b %d, %Y' 170 171# If true, SmartyPants will be used to convert quotes and dashes to 172# typographically correct entities. 173#html_use_smartypants = True 174 175# Custom sidebar templates, maps document names to template names. 176#html_sidebars = {} 177 178# Additional templates that should be rendered to pages, maps page names to 179# template names. 180#html_additional_pages = {} 181 182# If false, no module index is generated. 183#html_domain_indices = True 184 185# If false, no index is generated. 186#html_use_index = True 187 188# If true, the index is split into individual pages for each letter. 189#html_split_index = False 190 191# If true, links to the reST sources are added to the pages. 192#html_show_sourcelink = True 193 194# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 195#html_show_sphinx = True 196 197# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 198#html_show_copyright = True 199 200# If true, an OpenSearch description file will be output, and all pages will 201# contain a <link> tag referring to it. The value of this option must be the 202# base URL from which the finished HTML is served. 203#html_use_opensearch = '' 204 205# This is the file name suffix for HTML files (e.g. ".xhtml"). 206#html_file_suffix = None 207 208# Output file base name for HTML help builder. 209htmlhelp_basename = 'libcbordoc' 210 211 212# -- Options for LaTeX output --------------------------------------------- 213 214latex_elements = { 215# The paper size ('letterpaper' or 'a4paper'). 216#'papersize': 'letterpaper', 217 218# The font size ('10pt', '11pt' or '12pt'). 219#'pointsize': '10pt', 220 221# Additional stuff for the LaTeX preamble. 222#'preamble': '', 223} 224 225# Grouping the document tree into LaTeX files. List of tuples 226# (source start file, target name, title, 227# author, documentclass [howto, manual, or own class]). 228latex_documents = [ 229 ('index', 'libcbor.tex', 'libcbor Documentation', 230 'Pavel Kalvoda', 'manual'), 231] 232 233# The name of an image file (relative to this directory) to place at the top of 234# the title page. 235#latex_logo = None 236 237# For "manual" documents, if this is true, then toplevel headings are parts, 238# not chapters. 239#latex_use_parts = False 240 241# If true, show page references after internal links. 242#latex_show_pagerefs = False 243 244# If true, show URL addresses after external links. 245#latex_show_urls = False 246 247# Documents to append as an appendix to all manuals. 248#latex_appendices = [] 249 250# If false, no module index is generated. 251#latex_domain_indices = True 252 253 254# -- Options for manual page output --------------------------------------- 255 256# One entry per manual page. List of tuples 257# (source start file, name, description, authors, manual section). 258man_pages = [ 259 ('index', 'libcbor', 'libcbor Documentation', 260 ['Pavel Kalvoda'], 3) 261] 262 263# If true, show URL addresses after external links. 264#man_show_urls = False 265 266 267# -- Options for Texinfo output ------------------------------------------- 268 269# Grouping the document tree into Texinfo files. List of tuples 270# (source start file, target name, title, author, 271# dir menu entry, description, category) 272texinfo_documents = [ 273 ('index', 'libcbor', 'libcbor Documentation', 274 'Pavel Kalvoda', 'libcbor', 'C library for parsing and generating CBOR.', 275 'Miscellaneous'), 276] 277 278# Documents to append as an appendix to all manuals. 279#texinfo_appendices = [] 280 281# If false, no module index is generated. 282#texinfo_domain_indices = True 283 284# How to display URL addresses: 'footnote', 'no', or 'inline'. 285#texinfo_show_urls = 'footnote' 286 287# If true, do not generate a @detailmenu in the "Top" node's menu. 288#texinfo_no_detailmenu = False 289