blob: 82688a193aa661eefaa9cad8c2159e0ee1231cb5 [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.
Alexander Afanasyev5946ed12015-01-19 23:41:39 -080022sys.path.insert(0, os.path.abspath('.'))
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070023
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',
Alexander Afanasyev5946ed12015-01-19 23:41:39 -080034 'redmine_issue',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070035]
36
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070037def addExtensionIfExists(extension):
38 try:
39 __import__(extension)
40 extensions.append(extension)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070041 except ImportError:
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070042 sys.stderr.write("Extension '%s' in not available. "
43 "Some documentation may not build correctly.\n" % extension)
44 sys.stderr.write("To install, use \n"
45 " sudo pip install %s\n" % extension.replace('.', '-'))
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070046
Eric Newberryc6500a92018-03-25 14:21:07 -070047if sys.version_info[0] >= 3:
48 addExtensionIfExists('sphinxcontrib.doxylink')
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070049
Alexander Afanasyev5560fd42018-03-07 17:03:03 -050050# sphinxcontrib.googleanalytics is currently not working with the latest version of Sphinx
51# if os.getenv('GOOGLE_ANALYTICS', None):
52# addExtensionIfExists('sphinxcontrib.googleanalytics')
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070053
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070054# Add any paths that contain templates here, relative to this directory.
55templates_path = ['_templates']
56
57# The suffix of source filenames.
58source_suffix = '.rst'
59
60# The encoding of source files.
61#source_encoding = 'utf-8-sig'
62
63# The master toctree document.
64master_doc = 'index'
65
66# General information about the project.
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -070067project = u'ndn-cxx: NDN C++ library with eXperimental eXtensions'
Davide Pesaventofa995ac2019-03-27 23:44:46 -040068copyright = u'Copyright (c) 2013-2019 Regents of the University of California.'
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070069
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070070# The language for content autogenerated by Sphinx. Refer to documentation
71# for a list of supported languages.
72#language = None
73
74# There are two options for replacing |today|: either, you set today to some
75# non-false value, then it is used:
76#today = ''
77# Else, today_fmt is used as the format for a strftime call.
78#today_fmt = '%B %d, %Y'
79
80# List of patterns, relative to source directory, that match files and
81# directories to ignore when looking for source files.
82exclude_patterns = []
83
84# The reST default role (used for this markup: `text`) to use for all
85# documents.
86#default_role = None
87
88# If true, '()' will be appended to :func: etc. cross-reference text.
89#add_function_parentheses = True
90
91# If true, the current module name will be prepended to all description
92# unit titles (such as .. function::).
93#add_module_names = True
94
95# If true, sectionauthor and moduleauthor directives will be shown in the
96# output. They are ignored by default.
97#show_authors = False
98
99# The name of the Pygments (syntax highlighting) style to use.
100pygments_style = 'sphinx'
101
102# A list of ignored prefixes for module index sorting.
103#modindex_common_prefix = []
104
105# If true, keep warnings as "system message" paragraphs in the built documents.
106#keep_warnings = False
107
108
109# -- Options for HTML output ----------------------------------------------
110
111# The theme to use for HTML and HTML Help pages. See the documentation for
112# a list of builtin themes.
113# html_theme = 'default'
114html_theme = 'named_data_theme'
115
116# Theme options are theme-specific and customize the look and feel of a theme
117# further. For a list of options available for each theme, see the
118# documentation.
119#html_theme_options = {}
120
121# Add any paths that contain custom themes here, relative to this directory.
122html_theme_path = ['./']
123
124# The name for this set of Sphinx documents. If None, it defaults to
125# "<project> v<release> documentation".
126#html_title = None
127
128# A shorter title for the navigation bar. Default is the same as html_title.
129#html_short_title = None
130
131# The name of an image file (relative to this directory) to place at the top
132# of the sidebar.
133#html_logo = None
134
135# The name of an image file (within the static path) to use as favicon of the
136# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
137# pixels large.
138#html_favicon = None
139
140# Add any paths that contain custom static files (such as style sheets) here,
141# relative to this directory. They are copied after the builtin static files,
142# so a file named "default.css" will overwrite the builtin "default.css".
143html_static_path = ['_static']
144
145# Add any extra paths that contain custom files (such as robots.txt or
146# .htaccess) here, relative to this directory. These files are copied
147# directly to the root of the documentation.
148#html_extra_path = []
149
150# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
151# using the given strftime format.
152#html_last_updated_fmt = '%b %d, %Y'
153
154# If true, SmartyPants will be used to convert quotes and dashes to
155# typographically correct entities.
156#html_use_smartypants = True
157
158# Custom sidebar templates, maps document names to template names.
159#html_sidebars = {}
160
161# Additional templates that should be rendered to pages, maps page names to
162# template names.
163#html_additional_pages = {}
164
165# If false, no module index is generated.
166#html_domain_indices = True
167
168# If false, no index is generated.
169#html_use_index = True
170
171# If true, the index is split into individual pages for each letter.
172#html_split_index = False
173
174# If true, links to the reST sources are added to the pages.
175#html_show_sourcelink = True
176
177# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
178#html_show_sphinx = True
179
180# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
181#html_show_copyright = True
182
183# If true, an OpenSearch description file will be output, and all pages will
184# contain a <link> tag referring to it. The value of this option must be the
185# base URL from which the finished HTML is served.
186#html_use_opensearch = ''
187
188# This is the file name suffix for HTML files (e.g. ".xhtml").
189html_file_suffix = ".html"
190
191# Output file base name for HTML help builder.
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700192htmlhelp_basename = 'ndn-cxx-docs'
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700193
194
195# -- Options for LaTeX output ---------------------------------------------
196
197latex_elements = {
198# The paper size ('letterpaper' or 'a4paper').
199#'papersize': 'letterpaper',
200
201# The font size ('10pt', '11pt' or '12pt').
202#'pointsize': '10pt',
203
204# Additional stuff for the LaTeX preamble.
205#'preamble': '',
206}
207
208# Grouping the document tree into LaTeX files. List of tuples
209# (source start file, target name, title,
210# author, documentclass [howto, manual, or own class]).
211latex_documents = [
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700212 ('index', 'ndn-cxx-docs.tex', u'NDN C++ library with eXperimental eXtensions',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700213 u'Named Data Networking Project', 'manual'),
214]
215
216# The name of an image file (relative to this directory) to place at the top of
217# the title page.
218#latex_logo = None
219
220# For "manual" documents, if this is true, then toplevel headings are parts,
221# not chapters.
222#latex_use_parts = False
223
224# If true, show page references after internal links.
225#latex_show_pagerefs = False
226
227# If true, show URL addresses after external links.
228#latex_show_urls = False
229
230# Documents to append as an appendix to all manuals.
231#latex_appendices = []
232
233# If false, no module index is generated.
234#latex_domain_indices = True
235
236
237# -- Options for manual page output ---------------------------------------
238
239# One entry per manual page. List of tuples
240# (source start file, name, description, authors, manual section).
241man_pages = [
Davide Pesaventofa995ac2019-03-27 23:44:46 -0400242 ('manpages/ndnsec', 'ndnsec', 'NDN security toolkit', None, 1),
243 ('manpages/ndnsec-cert-dump', 'ndnsec-cert-dump', 'export an NDN certificate', None, 1),
244 ('manpages/ndnsec-cert-gen', 'ndnsec-cert-gen', 'create an NDN certificate for an identity', None, 1),
245 ('manpages/ndnsec-cert-install', 'ndnsec-cert-install', 'import an NDN certificate from a file', None, 1),
246 ('manpages/ndnsec-delete', 'ndnsec-delete', 'delete an NDN identity, key, or certificate', None, 1),
Junxiao Shi476200b2017-10-05 12:16:27 +0000247 ('manpages/ndnsec-export', 'ndnsec-export',
Davide Pesaventofa995ac2019-03-27 23:44:46 -0400248 'export an NDN certificate and its private key to a file', None, 1),
249 ('manpages/ndnsec-get-default', 'ndnsec-get-default',
250 'show the default NDN identity, key, and certificate for the current user', None, 1),
Junxiao Shi476200b2017-10-05 12:16:27 +0000251 ('manpages/ndnsec-import', 'ndnsec-import',
Davide Pesaventofa995ac2019-03-27 23:44:46 -0400252 'import an NDN certificate and its private key from a file', None, 1),
253 ('manpages/ndnsec-key-gen', 'ndnsec-key-gen',
254 'generate an NDN key for an identity', None, 1),
255 ('manpages/ndnsec-list', 'ndnsec-list',
256 'list all known NDN identities, keys, and certificates', None, 1),
257 ('manpages/ndnsec-set-default', 'ndnsec-set-default',
258 'change the default NDN identity, key, or certificate for the current user', None, 1),
259 ('manpages/ndnsec-sign-req', 'ndnsec-sign-req', 'generate an NDN certificate signing request', None, 1),
260 ('manpages/ndnsec-unlock-tpm', 'ndnsec-unlock-tpm', 'unlock the TPM', None, 1),
261 ('manpages/ndn-client.conf', 'ndn-client.conf', 'configuration file for NDN platform', None, 5),
262 ('manpages/ndn-log', 'ndn-log', 'ndn-cxx logging', None, 7),
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700263]
264
265
266# If true, show URL addresses after external links.
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700267man_show_urls = True
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700268
269
270# ---- Custom options --------
271
272doxylink = {
273 'ndn-cxx' : ('ndn-cxx.tag', 'doxygen/'),
274}
275
276if os.getenv('GOOGLE_ANALYTICS', None):
277 googleanalytics_id = os.environ['GOOGLE_ANALYTICS']
278 googleanalytics_enabled = True
279
Alexander Afanasyev5946ed12015-01-19 23:41:39 -0800280# exclude_patterns = ['RELEASE_NOTES.rst']
281
Davide Pesavento0530b5b2016-11-07 03:23:58 +0100282redmine_project_url = "https://redmine.named-data.net/"