]>
git.proxmox.com Git - mirror_frr.git/blob - doc/code/conf.py
1 # -*- coding: utf-8 -*-
3 # FRR documentation build configuration file, created by
4 # sphinx-quickstart on Tue Jan 31 16:00:52 2017.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
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
32 extensions
= ['sphinx.ext.todo']
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
'2017, FRR'
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 # The full version, including alpha/beta/rc tags.
62 val
= re
.compile('^S\["([^"]+)"\]="(.*)"$')
63 with
open('../../config.status', 'r') as cfgstatus
:
64 for ln
in cfgstatus
.readlines():
66 if m
is None: continue
67 if m
.group(1) == 'PACKAGE_VERSION':
69 version
= release
.split('-')[0]
71 # The language for content autogenerated by Sphinx. Refer to documentation
72 # for a list of supported languages.
74 # This is also used if you do content translation via gettext catalogs.
75 # Usually you set "language" from the command line for these cases.
78 # There are two options for replacing |today|: either, you set today to some
79 # non-false value, then it is used:
81 # Else, today_fmt is used as the format for a strftime call.
82 #today_fmt = '%B %d, %Y'
84 # List of patterns, relative to source directory, that match files and
85 # directories to ignore when looking for source files.
86 exclude_patterns
= ['_build']
88 # The reST default role (used for this markup: `text`) to use for all
92 # If true, '()' will be appended to :func: etc. cross-reference text.
93 #add_function_parentheses = True
95 # If true, the current module name will be prepended to all description
96 # unit titles (such as .. function::).
97 #add_module_names = True
99 # If true, sectionauthor and moduleauthor directives will be shown in the
100 # output. They are ignored by default.
101 #show_authors = False
103 # The name of the Pygments (syntax highlighting) style to use.
104 pygments_style
= 'sphinx'
106 # A list of ignored prefixes for module index sorting.
107 #modindex_common_prefix = []
109 # If true, keep warnings as "system message" paragraphs in the built documents.
110 #keep_warnings = False
112 # If true, `todo` and `todoList` produce output, else they produce nothing.
113 todo_include_todos
= True
116 # -- Options for HTML output ----------------------------------------------
118 # The theme to use for HTML and HTML Help pages. See the documentation for
119 # a list of builtin themes.
120 html_theme
= 'sphinx_rtd_theme'
122 # Theme options are theme-specific and customize the look and feel of a theme
123 # further. For a list of options available for each theme, see the
125 #html_theme_options = {}
127 # Add any paths that contain custom themes here, relative to this directory.
128 #html_theme_path = []
130 # The name for this set of Sphinx documents. If None, it defaults to
131 # "<project> v<release> documentation".
134 # A shorter title for the navigation bar. Default is the same as html_title.
135 #html_short_title = None
137 # The name of an image file (relative to this directory) to place at the top
141 # The name of an image file (within the static path) to use as favicon of the
142 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
146 # Add any paths that contain custom static files (such as style sheets) here,
147 # relative to this directory. They are copied after the builtin static files,
148 # so a file named "default.css" will overwrite the builtin "default.css".
149 html_static_path
= ['_static']
151 # Add any extra paths that contain custom files (such as robots.txt or
152 # .htaccess) here, relative to this directory. These files are copied
153 # directly to the root of the documentation.
154 #html_extra_path = []
156 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
157 # using the given strftime format.
158 #html_last_updated_fmt = '%b %d, %Y'
160 # If true, SmartyPants will be used to convert quotes and dashes to
161 # typographically correct entities.
162 #html_use_smartypants = True
164 # Custom sidebar templates, maps document names to template names.
167 # Additional templates that should be rendered to pages, maps page names to
169 #html_additional_pages = {}
171 # If false, no module index is generated.
172 #html_domain_indices = True
174 # If false, no index is generated.
175 #html_use_index = True
177 # If true, the index is split into individual pages for each letter.
178 #html_split_index = False
180 # If true, links to the reST sources are added to the pages.
181 #html_show_sourcelink = True
183 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
184 #html_show_sphinx = True
186 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
187 #html_show_copyright = True
189 # If true, an OpenSearch description file will be output, and all pages will
190 # contain a <link> tag referring to it. The value of this option must be the
191 # base URL from which the finished HTML is served.
192 #html_use_opensearch = ''
194 # This is the file name suffix for HTML files (e.g. ".xhtml").
195 #html_file_suffix = None
197 # Language to be used for generating the HTML full-text search index.
198 # Sphinx supports the following languages:
199 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
200 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
201 #html_search_language = 'en'
203 # A dictionary with options for the search language support, empty by default.
204 # Now only 'ja' uses this config value
205 #html_search_options = {'type': 'default'}
207 # The name of a javascript file (relative to the configuration directory) that
208 # implements a search results scorer. If empty, the default will be used.
209 #html_search_scorer = 'scorer.js'
211 # Output file base name for HTML help builder.
212 htmlhelp_basename
= 'FRRdoc'
214 # -- Options for LaTeX output ---------------------------------------------
217 # The paper size ('letterpaper' or 'a4paper').
218 #'papersize': 'letterpaper',
220 # The font size ('10pt', '11pt' or '12pt').
221 #'pointsize': '10pt',
223 # Additional stuff for the LaTeX preamble.
226 # Latex figure (float) alignment
227 #'figure_align': 'htbp',
230 # Grouping the document tree into LaTeX files. List of tuples
231 # (source start file, target name, title,
232 # author, documentclass [howto, manual, or own class]).
234 (master_doc
, 'FRR.tex', u
'FRR Documentation',
238 # The name of an image file (relative to this directory) to place at the top of
242 # For "manual" documents, if this is true, then toplevel headings are parts,
244 #latex_use_parts = False
246 # If true, show page references after internal links.
247 #latex_show_pagerefs = False
249 # If true, show URL addresses after external links.
250 #latex_show_urls = False
252 # Documents to append as an appendix to all manuals.
253 #latex_appendices = []
255 # If false, no module index is generated.
256 #latex_domain_indices = True
259 # -- Options for manual page output ---------------------------------------
261 # One entry per manual page. List of tuples
262 # (source start file, name, description, authors, manual section).
264 (master_doc
, 'frr', u
'FRR Documentation',
268 # If true, show URL addresses after external links.
269 #man_show_urls = False
272 # -- Options for Texinfo output -------------------------------------------
274 # Grouping the document tree into Texinfo files. List of tuples
275 # (source start file, target name, title, author,
276 # dir menu entry, description, category)
277 texinfo_documents
= [
278 (master_doc
, 'FRR', u
'FRR Documentation',
279 author
, 'FRR', 'One line description of project.',
283 # Documents to append as an appendix to all manuals.
284 #texinfo_appendices = []
286 # If false, no module index is generated.
287 #texinfo_domain_indices = True
289 # How to display URL addresses: 'footnote', 'no', or 'inline'.
290 #texinfo_show_urls = 'footnote'
292 # If true, do not generate a @detailmenu in the "Top" node's menu.
293 #texinfo_no_detailmenu = False