blob: 3fe24dd59891fd385439517da1c4a4d1fb034ff5 [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
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070036def addExtensionIfExists(extension):
37 try:
38 __import__(extension)
39 extensions.append(extension)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070040 except ImportError:
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070041 sys.stderr.write("Extension '%s' in not available. "
42 "Some documentation may not build correctly.\n" % extension)
43 sys.stderr.write("To install, use \n"
44 " sudo pip install %s\n" % extension.replace('.', '-'))
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070045
46addExtensionIfExists('sphinxcontrib.doxylink')
47
48if os.getenv('GOOGLE_ANALYTICS', None):
49 addExtensionIfExists('sphinxcontrib.googleanalytics')
50
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070051# Add any paths that contain templates here, relative to this directory.
52templates_path = ['_templates']
53
54# The suffix of source filenames.
55source_suffix = '.rst'
56
57# The encoding of source files.
58#source_encoding = 'utf-8-sig'
59
60# The master toctree document.
61master_doc = 'index'
62
63# General information about the project.
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -070064project = u'ndn-cxx: NDN C++ library with eXperimental eXtensions'
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070065copyright = u'2014, Named Data Networking Project'
66
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070067# The language for content autogenerated by Sphinx. Refer to documentation
68# for a list of supported languages.
69#language = None
70
71# There are two options for replacing |today|: either, you set today to some
72# non-false value, then it is used:
73#today = ''
74# Else, today_fmt is used as the format for a strftime call.
75#today_fmt = '%B %d, %Y'
76
77# List of patterns, relative to source directory, that match files and
78# directories to ignore when looking for source files.
79exclude_patterns = []
80
81# The reST default role (used for this markup: `text`) to use for all
82# documents.
83#default_role = None
84
85# If true, '()' will be appended to :func: etc. cross-reference text.
86#add_function_parentheses = True
87
88# If true, the current module name will be prepended to all description
89# unit titles (such as .. function::).
90#add_module_names = True
91
92# If true, sectionauthor and moduleauthor directives will be shown in the
93# output. They are ignored by default.
94#show_authors = False
95
96# The name of the Pygments (syntax highlighting) style to use.
97pygments_style = 'sphinx'
98
99# A list of ignored prefixes for module index sorting.
100#modindex_common_prefix = []
101
102# If true, keep warnings as "system message" paragraphs in the built documents.
103#keep_warnings = False
104
105
106# -- Options for HTML output ----------------------------------------------
107
108# The theme to use for HTML and HTML Help pages. See the documentation for
109# a list of builtin themes.
110# html_theme = 'default'
111html_theme = 'named_data_theme'
112
113# Theme options are theme-specific and customize the look and feel of a theme
114# further. For a list of options available for each theme, see the
115# documentation.
116#html_theme_options = {}
117
118# Add any paths that contain custom themes here, relative to this directory.
119html_theme_path = ['./']
120
121# The name for this set of Sphinx documents. If None, it defaults to
122# "<project> v<release> documentation".
123#html_title = None
124
125# A shorter title for the navigation bar. Default is the same as html_title.
126#html_short_title = None
127
128# The name of an image file (relative to this directory) to place at the top
129# of the sidebar.
130#html_logo = None
131
132# The name of an image file (within the static path) to use as favicon of the
133# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
134# pixels large.
135#html_favicon = None
136
137# Add any paths that contain custom static files (such as style sheets) here,
138# relative to this directory. They are copied after the builtin static files,
139# so a file named "default.css" will overwrite the builtin "default.css".
140html_static_path = ['_static']
141
142# Add any extra paths that contain custom files (such as robots.txt or
143# .htaccess) here, relative to this directory. These files are copied
144# directly to the root of the documentation.
145#html_extra_path = []
146
147# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
148# using the given strftime format.
149#html_last_updated_fmt = '%b %d, %Y'
150
151# If true, SmartyPants will be used to convert quotes and dashes to
152# typographically correct entities.
153#html_use_smartypants = True
154
155# Custom sidebar templates, maps document names to template names.
156#html_sidebars = {}
157
158# Additional templates that should be rendered to pages, maps page names to
159# template names.
160#html_additional_pages = {}
161
162# If false, no module index is generated.
163#html_domain_indices = True
164
165# If false, no index is generated.
166#html_use_index = True
167
168# If true, the index is split into individual pages for each letter.
169#html_split_index = False
170
171# If true, links to the reST sources are added to the pages.
172#html_show_sourcelink = True
173
174# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
175#html_show_sphinx = True
176
177# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
178#html_show_copyright = True
179
180# If true, an OpenSearch description file will be output, and all pages will
181# contain a <link> tag referring to it. The value of this option must be the
182# base URL from which the finished HTML is served.
183#html_use_opensearch = ''
184
185# This is the file name suffix for HTML files (e.g. ".xhtml").
186html_file_suffix = ".html"
187
188# Output file base name for HTML help builder.
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700189htmlhelp_basename = 'ndn-cxx-docs'
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700190
191
192# -- Options for LaTeX output ---------------------------------------------
193
194latex_elements = {
195# The paper size ('letterpaper' or 'a4paper').
196#'papersize': 'letterpaper',
197
198# The font size ('10pt', '11pt' or '12pt').
199#'pointsize': '10pt',
200
201# Additional stuff for the LaTeX preamble.
202#'preamble': '',
203}
204
205# Grouping the document tree into LaTeX files. List of tuples
206# (source start file, target name, title,
207# author, documentclass [howto, manual, or own class]).
208latex_documents = [
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700209 ('index', 'ndn-cxx-docs.tex', u'NDN C++ library with eXperimental eXtensions',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700210 u'Named Data Networking Project', 'manual'),
211]
212
213# The name of an image file (relative to this directory) to place at the top of
214# the title page.
215#latex_logo = None
216
217# For "manual" documents, if this is true, then toplevel headings are parts,
218# not chapters.
219#latex_use_parts = False
220
221# If true, show page references after internal links.
222#latex_show_pagerefs = False
223
224# If true, show URL addresses after external links.
225#latex_show_urls = False
226
227# Documents to append as an appendix to all manuals.
228#latex_appendices = []
229
230# If false, no module index is generated.
231#latex_domain_indices = True
232
233
234# -- Options for manual page output ---------------------------------------
235
236# One entry per manual page. List of tuples
237# (source start file, name, description, authors, manual section).
238man_pages = [
239 ('manpages/ndnsec', 'ndnsec', u'NDN security tools', None, 1),
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700240 ('manpages/ndnsec-cert-dump', 'ndnsec-cert-dump', 'part of NDN security tools', None, 1),
241 ('manpages/ndnsec-cert-gen', 'ndnsec-cert-gen', 'part of NDN security tools', None, 1),
242 ('manpages/ndnsec-cert-install', 'ndnsec-cert-instal', 'part of NDN security tools', None, 1),
243 ('manpages/ndnsec-delete', 'ndnsec-delete', 'part of NDN security tools', None, 1),
244 ('manpages/ndnsec-export', 'ndnsec-export', 'part of NDN security tools', None, 1),
245 ('manpages/ndnsec-get-default', 'ndnsec-get-default', 'part of NDN security tools', None, 1),
246 ('manpages/ndnsec-import', 'ndnsec-import', 'part of NDN security tools', None, 1),
247 ('manpages/ndnsec-key-gen', 'ndnsec-key-gen', 'part of NDN security tools', None, 1),
248 ('manpages/ndnsec-list', 'ndnsec-list', 'part of NDN security tools', None, 1),
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700249 ('manpages/ndnsec-set-acl', 'ndnsec-set-acl', 'part of NDN security tools', None, 1),
250 ('manpages/ndnsec-set-default', 'ndnsec-set-default', 'part of NDN security tools', None, 1),
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700251 ('manpages/ndnsec-sign-req', 'ndnsec-sign-req', 'part of NDN security tools', None, 1),
252 ('manpages/ndnsec-unlock-tpm', 'ndnsec-unlock-tpm', 'part of NDN security tools', None, 1),
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700253 ('tutorials/security-validator-config', 'ndnsec-validator.conf',
254 'NDN trust validator configuration file', None, 5),
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700255 ('manpages/tlvdump', 'tlvdump', 'Decode structure of TLV encoded buffer', None, 1),
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700256]
257
258
259# If true, show URL addresses after external links.
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700260man_show_urls = True
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700261
262
263# ---- Custom options --------
264
265doxylink = {
266 'ndn-cxx' : ('ndn-cxx.tag', 'doxygen/'),
267}
268
269if os.getenv('GOOGLE_ANALYTICS', None):
270 googleanalytics_id = os.environ['GOOGLE_ANALYTICS']
271 googleanalytics_enabled = True
272
273exclude_patterns = ['RELEASE_NOTES.rst']