]>
git.ipfire.org Git - people/ms/suricata.git/blob - doc/devguide/conf.py
1 # -*- coding: utf-8 -*-
3 # This file is execfile()d with the current directory set to its
6 # Note that not all possible configuration values are present in this
9 # All configuration values have a default; values that are commented out
10 # serve to show the default.
17 on_rtd
= os
.environ
.get('READTHEDOCS', None) == 'True'
19 # If extensions (or modules to document with autodoc) are in another directory,
20 # add these directories to sys.path here. If the directory is relative to the
21 # documentation root, use os.path.abspath to make it absolute, like shown here.
22 #sys.path.insert(0, os.path.abspath('.'))
24 # -- General configuration ------------------------------------------------
26 # If your documentation needs a minimal Sphinx version, state it here.
29 # Add any Sphinx extension module names here, as strings. They can be
30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 # Add any paths that contain templates here, relative to this directory.
35 templates_path
= ['_templates']
37 # The suffix(es) of source filenames.
38 # You can specify multiple suffix as a list of string:
39 # source_suffix = ['.rst', '.md']
40 source_suffix
= '.rst'
42 # The encoding of source files.
43 #source_encoding = 'utf-8-sig'
45 # The master toctree document.
48 # General information about the project.
50 copyright
= u
'2020, OISF'
53 # The version info for the project you're documenting, acts as replacement for
54 # |version| and |release|, also used in various other places throughout the
57 # The short X.Y version.
59 # Attempt to extract the version configure.ac.
61 version
= os
.environ
.get('version', None)
64 "AC_INIT\(\[suricata\],\s*\[(.*)?\]\)",
65 open("../../configure.ac").read()).groups()[0]
72 # The language for content autogenerated by Sphinx. Refer to documentation
73 # for a list of supported languages.
75 # This is also used if you do content translation via gettext catalogs.
76 # Usually you set "language" from the command line for these cases.
79 # There are two options for replacing |today|: either, you set today to some
80 # non-false value, then it is used:
82 # Else, today_fmt is used as the format for a strftime call.
83 #today_fmt = '%B %d, %Y'
85 # List of patterns, relative to source directory, that match files and
86 # directories to ignore when looking for source files.
91 # The reST default role (used for this markup: `text`) to use for all
95 # If true, '()' will be appended to :func: etc. cross-reference text.
96 #add_function_parentheses = True
98 # If true, the current module name will be prepended to all description
99 # unit titles (such as .. function::).
100 #add_module_names = True
102 # If true, sectionauthor and moduleauthor directives will be shown in the
103 # output. They are ignored by default.
104 #show_authors = False
106 # The name of the Pygments (syntax highlighting) style to use.
107 pygments_style
= 'sphinx'
109 # A list of ignored prefixes for module index sorting.
110 #modindex_common_prefix = []
112 # If true, keep warnings as "system message" paragraphs in the built documents.
113 #keep_warnings = False
115 # If true, `todo` and `todoList` produce output, else they produce nothing.
116 todo_include_todos
= False
119 # -- Options for HTML output ----------------------------------------------
121 # The theme to use for HTML and HTML Help pages. See the documentation for
122 # a list of builtin themes.
124 # Attempt to use the read the docs theme.
126 import sphinx_rtd_theme
127 html_theme
= 'sphinx_rtd_theme'
128 html_theme_path
= [sphinx_rtd_theme
.get_html_theme_path()]
130 html_theme
= 'default'
132 app
.add_stylesheet('css/suricata.css')
136 'https://media.readthedocs.org/css/sphinx_rtd_theme.css',
137 'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
138 '_static/css/suricata.css',
142 # Theme options are theme-specific and customize the look and feel of a theme
143 # further. For a list of options available for each theme, see the
145 #html_theme_options = {}
147 # Add any paths that contain custom themes here, relative to this directory.
148 #html_theme_path = []
150 # The name for this set of Sphinx documents. If None, it defaults to
151 # "<project> v<release> documentation".
154 # A shorter title for the navigation bar. Default is the same as html_title.
155 #html_short_title = None
157 # The name of an image file (relative to this directory) to place at the top
161 # The name of an image file (within the static path) to use as favicon of the
162 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
166 # Add any paths that contain custom static files (such as style sheets) here,
167 # relative to this directory. They are copied after the builtin static files,
168 # so a file named "default.css" will overwrite the builtin "default.css".
169 html_static_path
= ['_static']
171 # Add any extra paths that contain custom files (such as robots.txt or
172 # .htaccess) here, relative to this directory. These files are copied
173 # directly to the root of the documentation.
174 #html_extra_path = []
176 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
177 # using the given strftime format.
178 #html_last_updated_fmt = '%b %d, %Y'
180 # If true, SmartyPants will be used to convert quotes and dashes to
181 # typographically correct entities.
182 #html_use_smartypants = True
184 # Custom sidebar templates, maps document names to template names.
187 # Additional templates that should be rendered to pages, maps page names to
189 #html_additional_pages = {}
191 # If false, no module index is generated.
192 #html_domain_indices = True
194 # If false, no index is generated.
195 #html_use_index = True
197 # If true, the index is split into individual pages for each letter.
198 #html_split_index = False
200 # If true, links to the reST sources are added to the pages.
201 #html_show_sourcelink = True
203 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
204 #html_show_sphinx = True
206 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
207 #html_show_copyright = True
209 # If true, an OpenSearch description file will be output, and all pages will
210 # contain a <link> tag referring to it. The value of this option must be the
211 # base URL from which the finished HTML is served.
212 #html_use_opensearch = ''
214 # This is the file name suffix for HTML files (e.g. ".xhtml").
215 #html_file_suffix = None
217 # Language to be used for generating the HTML full-text search index.
218 # Sphinx supports the following languages:
219 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
220 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
221 #html_search_language = 'en'
223 # A dictionary with options for the search language support, empty by default.
224 # Now only 'ja' uses this config value
225 #html_search_options = {'type': 'default'}
227 # The name of a javascript file (relative to the configuration directory) that
228 # implements a search results scorer. If empty, the default will be used.
229 #html_search_scorer = 'scorer.js'
231 # Output file base name for HTML help builder.
232 htmlhelp_basename
= 'suricatadevdoc'
234 # -- Options for LaTeX output ---------------------------------------------
237 # The paper size ('letterpaper' or 'a4paper').
238 #'papersize': 'letterpaper',
240 # The font size ('10pt', '11pt' or '12pt').
241 #'pointsize': '10pt',
243 # Additional stuff for the LaTeX preamble.
246 # Latex figure (float) alignment
247 #'figure_align': 'htbp',
250 # Grouping the document tree into LaTeX files. List of tuples
251 # (source start file, target name, title,
252 # author, documentclass [howto, manual, or own class]).
254 (master_doc
, 'Suricata.tex', u
'Suricata Developer Guide',
258 # The name of an image file (relative to this directory) to place at the top of
262 # For "manual" documents, if this is true, then toplevel headings are parts,
264 #latex_use_parts = False
266 # If true, show page references after internal links.
267 #latex_show_pagerefs = False
269 # If true, show URL addresses after external links.
270 #latex_show_urls = False
272 # Documents to append as an appendix to all manuals.
273 #latex_appendices = []
275 # If false, no module index is generated.
276 #latex_domain_indices = True
278 # -- Options for Texinfo output -------------------------------------------
280 # Grouping the document tree into Texinfo files. List of tuples
281 # (source start file, target name, title, author,
282 # dir menu entry, description, category)
283 texinfo_documents
= [
284 (master_doc
, 'Suricata', u
'Suricata Developer Guide',
285 author
, 'Suricata', 'High performance NSM tool',
289 # Documents to append as an appendix to all manuals.
290 #texinfo_appendices = []
292 # If false, no module index is generated.
293 #texinfo_domain_indices = True
295 # How to display URL addresses: 'footnote', 'no', or 'inline'.
296 #texinfo_show_urls = 'footnote'
298 # If true, do not generate a @detailmenu in the "Top" node's menu.
299 #texinfo_no_detailmenu = False
302 .. |sysconfdir| replace:: %(sysconfdir)s
303 .. |localstatedir| replace:: %(localstatedir)s
305 "sysconfdir": os
.getenv("sysconfdir", "/etc"),
306 "localstatedir": os
.getenv("localstatedir", "/var"),