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