Debian Codegraph @

docs/conf.py

raw
1 # -*- coding: utf-8 -*-
2 # SPDX-License-Identifier: GPL-3.0-or-later
3 # SPDX-FileCopyrightText: Sven Eckelmann <[email protected]>
4
5 # Configuration file for the Sphinx documentation builder.
6 #
7 # This file does only contain a selection of the most common options. For a
8 # full list see the documentation:
9 # http://www.sphinx-doc.org/en/master/config
10
11 # -- Project information -----------------------------------------------------
12
13 project = u'ap51-flash'
14 copyright = u'ap51-flash Team'
15 author = u'ap51-flash Team'
16
17 # The short X.Y version
18 version = u'2025.0'
19 # The full version, including alpha/beta/rc tags
20 release = u'2025.0'
21
22
23 # -- General configuration ---------------------------------------------------
24
25 # If your documentation needs a minimal Sphinx version, state it here.
26 #
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.
32 extensions = [
33 ]
34
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path = ['_templates']
37
38 # The suffix(es) of source filenames.
39 # You can specify multiple suffix as a list of string:
40 #
41 # source_suffix = ['.rst', '.md']
42 source_suffix = '.rst'
43
44 # The master toctree document.
45 master_doc = 'index'
46
47 # The language for content autogenerated by Sphinx. Refer to documentation
48 # for a list of supported languages.
49 #
50 # This is also used if you do content translation via gettext catalogs.
51 # Usually you set "language" from the command line for these cases.
52 language = None
53
54 # List of patterns, relative to source directory, that match files and
55 # directories to ignore when looking for source files.
56 # This pattern also affects html_static_path and html_extra_path.
57 exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
58
59 # The name of the Pygments (syntax highlighting) style to use.
60 pygments_style = 'sphinx'
61
62
63 # -- Options for HTML output -------------------------------------------------
64
65 # The theme to use for HTML and HTML Help pages. See the documentation for
66 # a list of builtin themes.
67 #
68 html_theme = 'sphinx_rtd_theme'
69
70 # Theme options are theme-specific and customize the look and feel of a theme
71 # further. For a list of options available for each theme, see the
72 # documentation.
73 #
74 # html_theme_options = {}
75
76 # Add any paths that contain custom static files (such as style sheets) here,
77 # relative to this directory. They are copied after the builtin static files,
78 # so a file named "default.css" will overwrite the builtin "default.css".
79 html_static_path = ['_static']
80
81 # Custom sidebar templates, must be a dictionary that maps document names
82 # to template names.
83 #
84 # The default sidebars (for documents that don't match any pattern) are
85 # defined by theme itself. Builtin themes are using these templates by
86 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
87 # 'searchbox.html']``.
88 #
89 # html_sidebars = {}
90
91
92 # -- Options for HTMLHelp output ---------------------------------------------
93
94 # Output file base name for HTML help builder.
95 htmlhelp_basename = 'ap51-flashdoc'
96
97
98 # -- Options for LaTeX output ------------------------------------------------
99
100 latex_elements = {
101 # The paper size ('letterpaper' or 'a4paper').
102 #
103 # 'papersize': 'letterpaper',
104
105 # The font size ('10pt', '11pt' or '12pt').
106 #
107 # 'pointsize': '10pt',
108
109 # Additional stuff for the LaTeX preamble.
110 #
111 # 'preamble': '',
112
113 # Latex figure (float) alignment
114 #
115 # 'figure_align': 'htbp',
116 }
117
118 # Grouping the document tree into LaTeX files. List of tuples
119 # (source start file, target name, title,
120 # author, documentclass [howto, manual, or own class]).
121 latex_documents = [
122 (master_doc, 'ap51-flash.tex', u'ap51-flash Documentation',
123 u'ap51-flash Team', 'manual'),
124 ]
125
126
127 # -- Options for manual page output ------------------------------------------
128
129 # One entry per manual page. List of tuples
130 # (source start file, name, description, authors, manual section).
131 man_pages = [
132 (master_doc, 'ap51-flash', u'ap51-flash Documentation',
133 [author], 1)
134 ]
135
136
137 # -- Options for Texinfo output ----------------------------------------------
138
139 # Grouping the document tree into Texinfo files. List of tuples
140 # (source start file, target name, title, author,
141 # dir menu entry, description, category)
142 texinfo_documents = [
143 (master_doc, 'ap51-flash', u'ap51-flash Documentation',
144 author, 'ap51-flash', 'One line description of project.',
145 'Miscellaneous'),
146 ]
147
148
149 # -- Options for Epub output -------------------------------------------------
150
151 # Bibliographic Dublin Core info.
152 epub_title = project
153
154 # The unique identifier of the text. This can be a ISBN number
155 # or the project homepage.
156 #
157 # epub_identifier = ''
158
159 # A unique identification for the text.
160 #
161 # epub_uid = ''
162
163 # A list of files that should not be packed into the epub file.
164 epub_exclude_files = ['search.html']