blob: 4d2b58c0165b9938ad930260893cf356d76bb135 [file] [log] [blame]
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001# -*- coding: utf-8 -*-
2#
3# NFD - Named Data Networking Forwarding Daemon documentation build configuration file, created by
4# sphinx-quickstart on Sun Apr 6 19:58:22 2014.
5#
6# This file is execfile()d with the current directory set to its
7# containing dir.
8#
9# Note that not all possible configuration values are present in this
10# autogenerated file.
11#
12# All configuration values have a default; values that are commented out
13# serve to show the default.
14
15import sys
16import os
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -070017import re
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070018
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('.'))
23
24# -- General configuration ------------------------------------------------
25
26# If your documentation needs a minimal Sphinx version, state it here.
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.
32extensions = [
33 'sphinx.ext.todo',
34]
35
36# Add any paths that contain templates here, relative to this directory.
37templates_path = ['_templates']
38
39# The suffix of source filenames.
40source_suffix = '.rst'
41
42# The encoding of source files.
43#source_encoding = 'utf-8-sig'
44
45# The master toctree document.
46master_doc = 'index'
47
48# General information about the project.
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -070049project = u'ndn-cxx: NDN C++ library with eXperimental eXtensions'
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070050copyright = u'2014, Named Data Networking Project'
51
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070052# The language for content autogenerated by Sphinx. Refer to documentation
53# for a list of supported languages.
54#language = None
55
56# There are two options for replacing |today|: either, you set today to some
57# non-false value, then it is used:
58#today = ''
59# Else, today_fmt is used as the format for a strftime call.
60#today_fmt = '%B %d, %Y'
61
62# List of patterns, relative to source directory, that match files and
63# directories to ignore when looking for source files.
64exclude_patterns = []
65
66# The reST default role (used for this markup: `text`) to use for all
67# documents.
68#default_role = None
69
70# If true, '()' will be appended to :func: etc. cross-reference text.
71#add_function_parentheses = True
72
73# If true, the current module name will be prepended to all description
74# unit titles (such as .. function::).
75#add_module_names = True
76
77# If true, sectionauthor and moduleauthor directives will be shown in the
78# output. They are ignored by default.
79#show_authors = False
80
81# The name of the Pygments (syntax highlighting) style to use.
82pygments_style = 'sphinx'
83
84# A list of ignored prefixes for module index sorting.
85#modindex_common_prefix = []
86
87# If true, keep warnings as "system message" paragraphs in the built documents.
88#keep_warnings = False
89
90
91# -- Options for HTML output ----------------------------------------------
92
93# The theme to use for HTML and HTML Help pages. See the documentation for
94# a list of builtin themes.
95# html_theme = 'default'
96html_theme = 'named_data_theme'
97
98# Theme options are theme-specific and customize the look and feel of a theme
99# further. For a list of options available for each theme, see the
100# documentation.
101#html_theme_options = {}
102
103# Add any paths that contain custom themes here, relative to this directory.
104html_theme_path = ['./']
105
106# The name for this set of Sphinx documents. If None, it defaults to
107# "<project> v<release> documentation".
108#html_title = None
109
110# A shorter title for the navigation bar. Default is the same as html_title.
111#html_short_title = None
112
113# The name of an image file (relative to this directory) to place at the top
114# of the sidebar.
115#html_logo = None
116
117# The name of an image file (within the static path) to use as favicon of the
118# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
119# pixels large.
120#html_favicon = None
121
122# Add any paths that contain custom static files (such as style sheets) here,
123# relative to this directory. They are copied after the builtin static files,
124# so a file named "default.css" will overwrite the builtin "default.css".
125html_static_path = ['_static']
126
127# Add any extra paths that contain custom files (such as robots.txt or
128# .htaccess) here, relative to this directory. These files are copied
129# directly to the root of the documentation.
130#html_extra_path = []
131
132# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
133# using the given strftime format.
134#html_last_updated_fmt = '%b %d, %Y'
135
136# If true, SmartyPants will be used to convert quotes and dashes to
137# typographically correct entities.
138#html_use_smartypants = True
139
140# Custom sidebar templates, maps document names to template names.
141#html_sidebars = {}
142
143# Additional templates that should be rendered to pages, maps page names to
144# template names.
145#html_additional_pages = {}
146
147# If false, no module index is generated.
148#html_domain_indices = True
149
150# If false, no index is generated.
151#html_use_index = True
152
153# If true, the index is split into individual pages for each letter.
154#html_split_index = False
155
156# If true, links to the reST sources are added to the pages.
157#html_show_sourcelink = True
158
159# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
160#html_show_sphinx = True
161
162# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
163#html_show_copyright = True
164
165# If true, an OpenSearch description file will be output, and all pages will
166# contain a <link> tag referring to it. The value of this option must be the
167# base URL from which the finished HTML is served.
168#html_use_opensearch = ''
169
170# This is the file name suffix for HTML files (e.g. ".xhtml").
171html_file_suffix = ".html"
172
173# Output file base name for HTML help builder.
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700174htmlhelp_basename = 'ndn-cxx-docs'
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700175
176
177# -- Options for LaTeX output ---------------------------------------------
178
179latex_elements = {
180# The paper size ('letterpaper' or 'a4paper').
181#'papersize': 'letterpaper',
182
183# The font size ('10pt', '11pt' or '12pt').
184#'pointsize': '10pt',
185
186# Additional stuff for the LaTeX preamble.
187#'preamble': '',
188}
189
190# Grouping the document tree into LaTeX files. List of tuples
191# (source start file, target name, title,
192# author, documentclass [howto, manual, or own class]).
193latex_documents = [
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700194 ('index', 'ndn-cxx-docs.tex', u'NDN C++ library with eXperimental eXtensions',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700195 u'Named Data Networking Project', 'manual'),
196]
197
198# The name of an image file (relative to this directory) to place at the top of
199# the title page.
200#latex_logo = None
201
202# For "manual" documents, if this is true, then toplevel headings are parts,
203# not chapters.
204#latex_use_parts = False
205
206# If true, show page references after internal links.
207#latex_show_pagerefs = False
208
209# If true, show URL addresses after external links.
210#latex_show_urls = False
211
212# Documents to append as an appendix to all manuals.
213#latex_appendices = []
214
215# If false, no module index is generated.
216#latex_domain_indices = True
217
218
219# -- Options for manual page output ---------------------------------------
220
221# One entry per manual page. List of tuples
222# (source start file, name, description, authors, manual section).
223man_pages = [
224 ('manpages/ndnsec', 'ndnsec', u'NDN security tools', None, 1),
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700225 ('manpages/ndnsec-cert-dump', 'ndnsec-cert-dump', 'part of NDN security tools', None, 1),
226 ('manpages/ndnsec-cert-gen', 'ndnsec-cert-gen', 'part of NDN security tools', None, 1),
227 ('manpages/ndnsec-cert-install', 'ndnsec-cert-instal', 'part of NDN security tools', None, 1),
228 ('manpages/ndnsec-delete', 'ndnsec-delete', 'part of NDN security tools', None, 1),
229 ('manpages/ndnsec-export', 'ndnsec-export', 'part of NDN security tools', None, 1),
230 ('manpages/ndnsec-get-default', 'ndnsec-get-default', 'part of NDN security tools', None, 1),
231 ('manpages/ndnsec-import', 'ndnsec-import', 'part of NDN security tools', None, 1),
232 ('manpages/ndnsec-key-gen', 'ndnsec-key-gen', 'part of NDN security tools', None, 1),
233 ('manpages/ndnsec-list', 'ndnsec-list', 'part of NDN security tools', None, 1),
234 ('manpages/ndnsec-op-tool', 'ndnsec-op-tool', 'part of NDN security tools', None, 1),
235 ('manpages/ndnsec-set-acl', 'ndnsec-set-acl', 'part of NDN security tools', None, 1),
236 ('manpages/ndnsec-set-default', 'ndnsec-set-default', 'part of NDN security tools', None, 1),
237 ('manpages/ndnsec-sig-verify', 'ndnsec-sig-verify', 'part of NDN security tools', None, 1),
238 ('manpages/ndnsec-sign-req', 'ndnsec-sign-req', 'part of NDN security tools', None, 1),
239 ('manpages/ndnsec-unlock-tpm', 'ndnsec-unlock-tpm', 'part of NDN security tools', None, 1),
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700240 ('tutorials/security-validator-config', 'ndnsec-validator.conf',
241 'NDN trust validator configuration file', None, 5),
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700242 ('manpages/tlvdump', 'tlvdump', 'Decode structure of TLV encoded buffer', None, 1),
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700243]
244
245
246# If true, show URL addresses after external links.
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700247man_show_urls = True