]>
git.proxmox.com Git - mirror_frr.git/blob - doc/manpages/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 # prolog for various variable substitutions
32 # Add any Sphinx extension module names here, as strings. They can be
33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
35 extensions
= ['sphinx.ext.todo']
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path
= ['_templates']
40 # The suffix(es) of source filenames.
41 # You can specify multiple suffix as a list of string:
42 # source_suffix = ['.rst']
43 source_suffix
= '.rst'
45 # The encoding of source files.
46 #source_encoding = 'utf-8-sig'
48 # The master toctree document.
51 # General information about the project.
53 copyright
= u
'2017, FRR'
54 author
= u
'FRR authors'
56 # The version info for the project you're documenting, acts as replacement for
57 # |version| and |release|, also used in various other places throughout the
60 # The short X.Y version.
62 # The full version, including alpha/beta/rc tags.
66 # -----------------------------------------------------------------------------
67 # Extract values from codebase for substitution into docs.
68 # -----------------------------------------------------------------------------
70 # Various installation prefixes. Values are extracted from config.status.
71 # Reasonable defaults are set in case that file does not exist.
74 'COPYRIGHT_YEAR': '1999-2005',
75 'COPYRIGHT_STR': 'Copyright (c) 1999-2005',
76 'PACKAGE_NAME': project
.lower(),
77 'PACKAGE_TARNAME': project
.lower(),
78 'PACKAGE_STRING': project
.lower() + ' latest',
79 'PACKAGE_URL': 'https://frrouting.org/',
80 'PACKAGE_VERSION': 'latest',
81 'INSTALL_PREFIX_ETC': '/etc/frr',
82 'INSTALL_PREFIX_SBIN': '/usr/lib/frr',
83 'INSTALL_PREFIX_STATE': '/var/run/frr',
84 'INSTALL_PREFIX_MODULES': '/usr/lib/frr/modules',
85 'INSTALL_USER': 'frr',
86 'INSTALL_GROUP': 'frr',
87 'INSTALL_VTY_GROUP': 'frrvty',
92 # extract version information, installation location, other stuff we need to
93 # use when building final documents
94 val
= re
.compile('^S\["([^"]+)"\]="(.*)"$')
96 with
open('../../config.status', 'r') as cfgstatus
:
97 for ln
in cfgstatus
.readlines():
99 if not m
or m
.group(1) not in replace_vars
.keys(): continue
100 replace_vars
[m
.group(1)] = m
.group(2)
102 # if config.status doesn't exist, just ignore it
105 # manually fill out some of these we can't get from config.status
106 replace_vars
['COPYRIGHT_STR'] = "Copyright (c)"
107 replace_vars
['COPYRIGHT_STR'] += ' {0}'.format(replace_vars
['COPYRIGHT_YEAR'])
108 replace_vars
['COPYRIGHT_STR'] += ' {0}'.format(replace_vars
['AUTHORS'])
109 release
= replace_vars
['PACKAGE_VERSION']
110 version
= release
.split('-')[0]
112 # add substitutions to prolog
113 for key
, value
in replace_vars
.items():
114 rst_prolog
+= '.. |{0}| replace:: {1}\n'.format(key
, value
)
117 # The language for content autogenerated by Sphinx. Refer to documentation
118 # for a list of supported languages.
120 # This is also used if you do content translation via gettext catalogs.
121 # Usually you set "language" from the command line for these cases.
124 # There are two options for replacing |today|: either, you set today to some
125 # non-false value, then it is used:
127 # Else, today_fmt is used as the format for a strftime call.
128 #today_fmt = '%B %d, %Y'
130 # List of patterns, relative to source directory, that match files and
131 # directories to ignore when looking for source files.
132 exclude_patterns
= ['_build', 'common-options.rst', 'epilogue.rst', 'defines.rst', 'bfd-options.rst']
134 # The reST default role (used for this markup: `text`) to use for all
138 # If true, '()' will be appended to :func: etc. cross-reference text.
139 #add_function_parentheses = True
141 # If true, the current module name will be prepended to all description
142 # unit titles (such as .. function::).
143 #add_module_names = True
145 # If true, sectionauthor and moduleauthor directives will be shown in the
146 # output. They are ignored by default.
147 #show_authors = False
149 # The name of the Pygments (syntax highlighting) style to use.
150 pygments_style
= 'sphinx'
152 # A list of ignored prefixes for module index sorting.
153 #modindex_common_prefix = []
155 # If true, keep warnings as "system message" paragraphs in the built documents.
156 #keep_warnings = False
158 # If true, `todo` and `todoList` produce output, else they produce nothing.
159 todo_include_todos
= True
162 # -- Options for HTML output ----------------------------------------------
164 # The theme to use for HTML and HTML Help pages. See the documentation for
165 # a list of builtin themes.
166 html_theme
= 'default'
168 # Theme options are theme-specific and customize the look and feel of a theme
169 # further. For a list of options available for each theme, see the
171 #html_theme_options = {}
173 # Add any paths that contain custom themes here, relative to this directory.
174 #html_theme_path = []
176 # The name for this set of Sphinx documents. If None, it defaults to
177 # "<project> v<release> documentation".
180 # A shorter title for the navigation bar. Default is the same as html_title.
181 #html_short_title = None
183 # The name of an image file (relative to this directory) to place at the top
187 # The name of an image file (within the static path) to use as favicon of the
188 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
192 # Add any paths that contain custom static files (such as style sheets) here,
193 # relative to this directory. They are copied after the builtin static files,
194 # so a file named "default.css" will overwrite the builtin "default.css".
195 html_static_path
= ['_static']
197 # Add any extra paths that contain custom files (such as robots.txt or
198 # .htaccess) here, relative to this directory. These files are copied
199 # directly to the root of the documentation.
200 #html_extra_path = []
202 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
203 # using the given strftime format.
204 #html_last_updated_fmt = '%b %d, %Y'
206 # If true, SmartyPants will be used to convert quotes and dashes to
207 # typographically correct entities.
208 #html_use_smartypants = True
210 # Custom sidebar templates, maps document names to template names.
213 # Additional templates that should be rendered to pages, maps page names to
215 #html_additional_pages = {}
217 # If false, no module index is generated.
218 #html_domain_indices = True
220 # If false, no index is generated.
221 #html_use_index = True
223 # If true, the index is split into individual pages for each letter.
224 #html_split_index = False
226 # If true, links to the reST sources are added to the pages.
227 #html_show_sourcelink = True
229 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
230 #html_show_sphinx = True
232 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
233 #html_show_copyright = True
235 # If true, an OpenSearch description file will be output, and all pages will
236 # contain a <link> tag referring to it. The value of this option must be the
237 # base URL from which the finished HTML is served.
238 #html_use_opensearch = ''
240 # This is the file name suffix for HTML files (e.g. ".xhtml").
241 #html_file_suffix = None
243 # Language to be used for generating the HTML full-text search index.
244 # Sphinx supports the following languages:
245 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
246 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
247 #html_search_language = 'en'
249 # A dictionary with options for the search language support, empty by default.
250 # Now only 'ja' uses this config value
251 #html_search_options = {'type': 'default'}
253 # The name of a javascript file (relative to the configuration directory) that
254 # implements a search results scorer. If empty, the default will be used.
255 #html_search_scorer = 'scorer.js'
257 # Output file base name for HTML help builder.
258 htmlhelp_basename
= 'FRRdoc'
260 # -- Options for LaTeX output ---------------------------------------------
263 # The paper size ('letterpaper' or 'a4paper').
264 #'papersize': 'letterpaper',
266 # The font size ('10pt', '11pt' or '12pt').
267 #'pointsize': '10pt',
269 # Additional stuff for the LaTeX preamble.
272 # Latex figure (float) alignment
273 #'figure_align': 'htbp',
276 # Grouping the document tree into LaTeX files. List of tuples
277 # (source start file, target name, title,
278 # author, documentclass [howto, manual, or own class]).
280 (master_doc
, 'FRR.tex', u
'FRR User Manual',
284 # The name of an image file (relative to this directory) to place at the top of
288 # For "manual" documents, if this is true, then toplevel headings are parts,
290 #latex_use_parts = False
292 # If true, show page references after internal links.
293 #latex_show_pagerefs = False
295 # If true, show URL addresses after external links.
296 #latex_show_urls = False
298 # Documents to append as an appendix to all manuals.
299 #latex_appendices = []
301 # If false, no module index is generated.
302 #latex_domain_indices = True
305 # -- Options for manual page output ---------------------------------------
307 # One entry per manual page. List of tuples
308 # (source start file, name, description, authors, manual section).
310 # If true, show URL addresses after external links.
311 #man_show_urls = False
313 fwfrr
= "{0} routing engine for use with FRRouting."
316 ('frr-bfdd', 'frr-bfdd', fwfrr
.format("a bfd"), [], 8),
317 ('frr-bgpd', 'frr-bgpd', fwfrr
.format("a BGPv4, BGPv4+, BGPv4-"), [], 8),
318 ('frr-eigrpd', 'frr-eigrpd', fwfrr
.format("an EIGRP"), [], 8),
319 ('frr-fabricd', 'frr-fabricd', fwfrr
.format("an OpenFabric"), [], 8),
320 ('frr-isisd', 'frr-isisd', fwfrr
.format("an IS-IS"), [], 8),
321 ('frr-ldpd', 'frr-ldpd', fwfrr
.format("an LDP"), [], 8),
322 ('frr-nhrpd', 'frr-nhrpd', fwfrr
.format("a Next Hop Routing Protocol"), [], 8),
323 ('frr-ospf6d', 'frr-ospf6d', fwfrr
.format("an OSPFv3"), [], 8),
324 ('frr-ospfclient', 'frr-ospfclient', 'an example ospf-api client', [], 8),
325 ('frr-ospfd', 'frr-ospfd', fwfrr
.format("an OSPFv2"), [], 8),
326 ('frr-pbrd', 'frr-pbrd', fwfrr
.format("a PBR"), [], 8),
327 ('frr-pimd', 'frr-pimd', fwfrr
.format("a PIM"), [], 8),
328 ('frr-ripd', 'frr-ripd', fwfrr
.format("a RIP"), [], 8),
329 ('frr-ripngd', 'frr-ripngd', fwfrr
.format("a RIPNG"), [], 8),
330 ('frr-sharpd', 'frr-sharpd', fwfrr
.format("a SHARP"), [], 8),
331 ('frr-staticd', 'frr-staticd', fwfrr
.format("a static route manager"), [], 8),
332 ('frr-vrrpd', 'frr-vrrpd', fwfrr
.format("a VRRP"), [], 8),
333 ('frr-watchfrr', 'frr-watchfrr', 'a program to monitor the status of FRRouting daemons', [], 8),
334 ('frr-zebra', 'frr-zebra', 'a routing manager for use with associated FRRouting components.', [], 8),
335 ('frr', 'frr', 'a systemd interaction script', [], 1),
336 ('mtracebis', 'mtracebis', "a multicast trace client", [], 8),
337 ('vtysh', 'vtysh', 'an integrated shell for FRRouting.', [], 1),
340 # -- Options for Texinfo output -------------------------------------------
342 # Grouping the document tree into Texinfo files. List of tuples
343 # (source start file, target name, title, author,
344 # dir menu entry, description, category)
346 # Documents to append as an appendix to all manuals.
347 #texinfo_appendices = []
349 # If false, no module index is generated.
350 #texinfo_domain_indices = True
352 # How to display URL addresses: 'footnote', 'no', or 'inline'.
353 #texinfo_show_urls = 'footnote'
355 # If true, do not generate a @detailmenu in the "Top" node's menu.
356 #texinfo_no_detailmenu = False
358 # custom extensions here