blob: a2df0fc6243acd998ee749df65782397bf8a20b2 [file] [log] [blame]
Davide Pesaventob310efb2019-04-11 22:10:24 -04001# Configuration file for the Sphinx documentation builder.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07002#
Davide Pesaventob310efb2019-04-11 22:10:24 -04003# This file only contains a selection of the most common options. For a full
4# list see the documentation:
Davide Pesaventofa33f8d2020-09-19 18:48:42 -04005# https://www.sphinx-doc.org/en/master/usage/configuration.html
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07006
Davide Pesaventob310efb2019-04-11 22:10:24 -04007# -- Path setup --------------------------------------------------------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07008
9# If extensions (or modules to document with autodoc) are in another directory,
10# add these directories to sys.path here. If the directory is relative to the
11# documentation root, use os.path.abspath to make it absolute, like shown here.
Davide Pesaventob310efb2019-04-11 22:10:24 -040012#
Davide Pesaventoab7300b2020-04-09 00:51:41 -040013# import os
Davide Pesaventob310efb2019-04-11 22:10:24 -040014import sys
15# sys.path.insert(0, os.path.abspath('.'))
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070016
Davide Pesaventob310efb2019-04-11 22:10:24 -040017
18# -- Project information -----------------------------------------------------
19
20project = u'ndn-cxx: NDN C++ library with eXperimental eXtensions'
Davide Pesaventoab7300b2020-04-09 00:51:41 -040021copyright = u'Copyright © 2013-2020 Regents of the University of California.'
Davide Pesaventob310efb2019-04-11 22:10:24 -040022author = u'Named Data Networking Project'
23
Davide Pesavento933a5672020-07-03 22:32:43 -040024# The short X.Y version.
Davide Pesaventob310efb2019-04-11 22:10:24 -040025#version = ''
26
Davide Pesavento933a5672020-07-03 22:32:43 -040027# The full version, including alpha/beta/rc tags.
Davide Pesaventob310efb2019-04-11 22:10:24 -040028#release = ''
29
30# There are two options for replacing |today|: either, you set today to some
31# non-false value, then it is used:
32#today = ''
33# Else, today_fmt is used as the format for a strftime call.
34today_fmt = '%Y-%m-%d'
35
36
37# -- General configuration ---------------------------------------------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070038
39# If your documentation needs a minimal Sphinx version, state it here.
Davide Pesaventob310efb2019-04-11 22:10:24 -040040#
Davide Pesavento933a5672020-07-03 22:32:43 -040041needs_sphinx = '1.3'
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070042
43# Add any Sphinx extension module names here, as strings. They can be
44# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
45# ones.
46extensions = [
Davide Pesaventob310efb2019-04-11 22:10:24 -040047 'sphinx.ext.extlinks',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070048 'sphinx.ext.todo',
49]
50
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070051def addExtensionIfExists(extension):
52 try:
53 __import__(extension)
54 extensions.append(extension)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070055 except ImportError:
Davide Pesaventob310efb2019-04-11 22:10:24 -040056 sys.stderr.write("Extension '%s' not found. "
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070057 "Some documentation may not build correctly.\n" % extension)
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070058
Davide Pesaventod776a932020-03-20 18:42:36 -040059addExtensionIfExists('sphinxcontrib.doxylink')
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070060
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070061# The master toctree document.
62master_doc = 'index'
63
Davide Pesaventob310efb2019-04-11 22:10:24 -040064# Add any paths that contain templates here, relative to this directory.
65templates_path = ['_templates']
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070066
67# List of patterns, relative to source directory, that match files and
68# directories to ignore when looking for source files.
Davide Pesaventob310efb2019-04-11 22:10:24 -040069# This pattern also affects html_static_path and html_extra_path.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070070exclude_patterns = []
71
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070072
Davide Pesaventob310efb2019-04-11 22:10:24 -040073# -- Options for HTML output -------------------------------------------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070074
75# The theme to use for HTML and HTML Help pages. See the documentation for
76# a list of builtin themes.
Davide Pesaventob310efb2019-04-11 22:10:24 -040077#
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070078html_theme = 'named_data_theme'
79
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070080# Add any paths that contain custom themes here, relative to this directory.
Davide Pesaventob310efb2019-04-11 22:10:24 -040081html_theme_path = ['.']
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070082
83# Add any paths that contain custom static files (such as style sheets) here,
84# relative to this directory. They are copied after the builtin static files,
85# so a file named "default.css" will overwrite the builtin "default.css".
86html_static_path = ['_static']
87
Davide Pesaventofa33f8d2020-09-19 18:48:42 -040088html_copy_source = False
89html_show_sourcelink = False
90
Davide Pesavento933a5672020-07-03 22:32:43 -040091# Disable syntax highlighting of code blocks by default.
92highlight_language = 'none'
93
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070094
Davide Pesaventob310efb2019-04-11 22:10:24 -040095# -- Options for LaTeX output ------------------------------------------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070096
97latex_elements = {
Davide Pesaventob310efb2019-04-11 22:10:24 -040098 # The paper size ('letterpaper' or 'a4paper').
99 #
100 # 'papersize': 'letterpaper',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700101
Davide Pesaventob310efb2019-04-11 22:10:24 -0400102 # The font size ('10pt', '11pt' or '12pt').
103 #
104 # 'pointsize': '10pt',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700105
Davide Pesaventob310efb2019-04-11 22:10:24 -0400106 # Additional stuff for the LaTeX preamble.
107 #
108 # 'preamble': '',
109
110 # Latex figure (float) alignment
111 #
112 # 'figure_align': 'htbp',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700113}
114
115# Grouping the document tree into LaTeX files. List of tuples
116# (source start file, target name, title,
117# author, documentclass [howto, manual, or own class]).
118latex_documents = [
Davide Pesaventob310efb2019-04-11 22:10:24 -0400119 ('index', 'ndn-cxx-docs.tex', u'NDN C++ library with eXperimental eXtensions',
120 author, 'manual'),
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700121]
122
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700123
Davide Pesaventob310efb2019-04-11 22:10:24 -0400124# -- Options for manual page output ------------------------------------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700125
126# One entry per manual page. List of tuples
127# (source start file, name, description, authors, manual section).
128man_pages = [
Davide Pesaventob310efb2019-04-11 22:10:24 -0400129 ('manpages/ndnsec', 'ndnsec', 'NDN security toolkit', None, 1),
130 ('manpages/ndnsec-cert-dump', 'ndnsec-cert-dump', 'export an NDN certificate', None, 1),
131 ('manpages/ndnsec-cert-gen', 'ndnsec-cert-gen', 'create an NDN certificate for an identity', None, 1),
132 ('manpages/ndnsec-cert-install', 'ndnsec-cert-install', 'import an NDN certificate from a file', None, 1),
133 ('manpages/ndnsec-delete', 'ndnsec-delete', 'delete an NDN identity, key, or certificate', None, 1),
134 ('manpages/ndnsec-export', 'ndnsec-export', 'export an NDN certificate and its private key to a file', None, 1),
135 ('manpages/ndnsec-get-default', 'ndnsec-get-default', 'show the default NDN identity, key, and certificate for the current user', None, 1),
136 ('manpages/ndnsec-import', 'ndnsec-import', 'import an NDN certificate and its private key from a file', None, 1),
137 ('manpages/ndnsec-key-gen', 'ndnsec-key-gen', 'generate an NDN key for an identity', None, 1),
138 ('manpages/ndnsec-list', 'ndnsec-list', 'list all known NDN identities, keys, and certificates', None, 1),
139 ('manpages/ndnsec-set-default', 'ndnsec-set-default', 'change the default NDN identity, key, or certificate for the current user', None, 1),
140 ('manpages/ndnsec-sign-req', 'ndnsec-sign-req', 'generate an NDN certificate signing request', None, 1),
141 ('manpages/ndnsec-unlock-tpm', 'ndnsec-unlock-tpm', 'unlock the TPM', None, 1),
Davide Pesaventoab7300b2020-04-09 00:51:41 -0400142 ('manpages/ndn-client.conf', 'ndn-client.conf', 'configuration file for NDN applications', None, 5),
Davide Pesaventob310efb2019-04-11 22:10:24 -0400143 ('manpages/ndn-log', 'ndn-log', 'ndn-cxx logging', None, 7),
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700144]
145
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700146# If true, show URL addresses after external links.
Davide Pesaventob310efb2019-04-11 22:10:24 -0400147#man_show_urls = True
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700148
149
Davide Pesaventob310efb2019-04-11 22:10:24 -0400150# -- Custom options ----------------------------------------------------------
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700151
152doxylink = {
Davide Pesaventob310efb2019-04-11 22:10:24 -0400153 'ndn-cxx': ('ndn-cxx.tag', 'doxygen/'),
154}
155
156extlinks = {
157 'issue': ('https://redmine.named-data.net/issues/%s', 'issue #'),
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700158}