Debian Codegraph @

doc/spec/element_conf.py

raw
1 #!/usr/bin/env python3
2 ############################################################################
3 # Copyright (C) Intel Corporation
4 #
5 # SPDX-License-Identifier: MIT
6 ############################################################################
7 """
8 Configuration file for the Sphinx documentation builder.
9 """
10 # pylint: disable=invalid-name
11
12 # Derived from:
13 # github.com/oneapi-src/oneAPI-spec/blob/main/source/conf/element_conf.py
14
15 # -*- coding: utf-8 -*-
16 #
17 # Configuration file for the Sphinx documentation builder.
18 #
19 # This file does only contain a selection of the most common options. For a
20 # full list see the documentation:
21 # http://www.sphinx-doc.org/en/master/config
22
23 # -- Path setup --------------------------------------------------------------
24
25 # If extensions (or modules to document with autodoc) are in another directory,
26 # add these directories to sys.path here. If the directory is relative to the
27 # documentation root, use os.path.abspath to make it absolute, like shown here.
28 #
29
30 # -- Project information -----------------------------------------------------
31
32 # Included in page footers. ''project_copyright'' is an allowed alias to
33 # 'copyright' to avoid conflict with built-in keyword
34 project_copyright = '2023, Intel'
35
36 # The short X.Y version
37 version = ''
38 # The full version, including alpha/beta/rc tags
39 release = ''
40
41 # -- General configuration ---------------------------------------------------
42
43 # If your documentation needs a minimal Sphinx version, state it here.
44 #
45 # needs_sphinx = '1.0'
46
47 # Add any paths that contain templates here, relative to this directory.
48 templates_path = ['_templates']
49
50 # The suffix(es) of source filenames.
51 # You can specify multiple suffix as a list of string:
52 #
53 # source_suffix = ['.rst', '.md']
54 source_suffix = '.rst'
55
56 # The master toctree document.
57 master_doc = 'index'
58
59 # List of patterns, relative to source directory, that match files and
60 # directories to ignore when looking for source files.
61 # This pattern also affects html_static_path and html_extra_path.
62 exclude_patterns = ['**/*.inc.rst']
63
64 # The name of the Pygments (syntax highlighting) style to use.
65 pygments_style = None
66
67 # -- Options for HTML output -------------------------------------------------
68
69 # The theme to use for HTML and HTML Help pages. See the documentation for
70 # a list of builtin themes.
71 #
72 html_theme = 'sphinx_book_theme'
73
74 # Theme options are theme-specific and customize the look and feel of a theme
75 # further. For a list of options available for each theme, see the
76 # documentation.
77 #
78 # html_theme_options = {}
79
80 # Add any paths that contain custom static files (such as style sheets) here,
81 # relative to this directory. They are copied after the builtin static files,
82 # so a file named "default.css" will overwrite the builtin "default.css".
83 #
84 # html_static_path = ['../../../_static']
85
86 # Custom sidebar templates, must be a dictionary that maps document names
87 # to template names.
88 #
89 # The default sidebars (for documents that don't match any pattern) are
90 # defined by theme itself. Builtin themes are using these templates by
91 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
92 # 'searchbox.html']``.
93 #
94 # html_sidebars = {}
95
96 # -- Options for HTMLHelp output ---------------------------------------------
97
98 # Output file base name for HTML help builder.
99 htmlhelp_basename = project + '-spec' # pylint: disable=E0602
100
101 # -- Options for LaTeX output ------------------------------------------------
102
103 # Grouping the document tree into LaTeX files. List of tuples
104 # (source start file, target name, title,
105 # author, documentclass [howto, manual, or own class]).
106 pro = project.translate(project.maketrans(' ', '-')) # pylint: disable=E0602
107 file_name = f'{pro}-spec.tex'
108 latex_documents = [
109 (
110 master_doc,
111 file_name,
112 project + ' Specification', # pylint: disable=E0602
113 'Intel',
114 'manual',
115 ),
116 ]
117
118 # -- Options for Epub output -------------------------------------------------
119
120 # Bibliographic Dublin Core info.
121 epub_title = project # pylint: disable=E0602
122
123 # The unique identifier of the text. This can be a ISBN number
124 # or the project homepage.
125 #
126 # epub_identifier = ''
127
128 # A unique identification for the text.
129 #
130 # epub_uid = ''
131
132 # A list of files that should not be packed into the epub file.
133 epub_exclude_files = ['search.html']
134
135 # -- Extension configuration -------------------------------------------------
136
137 # -- Options for todo extension ----------------------------------------------
138
139 # If true, `todo` and `todoList` produce output, else they produce nothing.
140 todo_include_todos = True
141
142 # -- Options for breathe extension -------------------------------------------
143
144 breathe_projects = {'DEF_BREATHE_PROJECT': '../doxygen/xml'} # pylint: disable=E0602
145 breathe_default_project = 'none'