blob: 2e3a1df43cc65c7453991339f53bcf9f58afdc8a [file] [log] [blame]
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001# -*- coding: utf-8 -*-
2#
Davide Pesaventob310efb2019-04-11 22:10:24 -04003# Configuration file for the Sphinx documentation builder.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07004#
Davide Pesaventob310efb2019-04-11 22:10:24 -04005# This file only contains a selection of the most common options. For a full
6# list see the documentation:
7# http://www.sphinx-doc.org/en/master/config
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07008
Davide Pesaventob310efb2019-04-11 22:10:24 -04009# -- Path setup --------------------------------------------------------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070010
11# If extensions (or modules to document with autodoc) are in another directory,
12# add these directories to sys.path here. If the directory is relative to the
13# documentation root, use os.path.abspath to make it absolute, like shown here.
Davide Pesaventob310efb2019-04-11 22:10:24 -040014#
15import os
16import sys
17# sys.path.insert(0, os.path.abspath('.'))
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070018
Davide Pesaventob310efb2019-04-11 22:10:24 -040019
20# -- Project information -----------------------------------------------------
21
22project = u'ndn-cxx: NDN C++ library with eXperimental eXtensions'
23copyright = u'Copyright © 2013-2019 Regents of the University of California.'
24author = u'Named Data Networking Project'
25
26# The short X.Y version
27#version = ''
28
29# The full version, including alpha/beta/rc tags
30#release = ''
31
32# There are two options for replacing |today|: either, you set today to some
33# non-false value, then it is used:
34#today = ''
35# Else, today_fmt is used as the format for a strftime call.
36today_fmt = '%Y-%m-%d'
37
38
39# -- General configuration ---------------------------------------------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070040
41# If your documentation needs a minimal Sphinx version, state it here.
Davide Pesaventob310efb2019-04-11 22:10:24 -040042#
43needs_sphinx = '1.1'
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070044
45# Add any Sphinx extension module names here, as strings. They can be
46# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
47# ones.
48extensions = [
Davide Pesaventob310efb2019-04-11 22:10:24 -040049 'sphinx.ext.extlinks',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070050 'sphinx.ext.todo',
51]
52
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070053def addExtensionIfExists(extension):
54 try:
55 __import__(extension)
56 extensions.append(extension)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070057 except ImportError:
Davide Pesaventob310efb2019-04-11 22:10:24 -040058 sys.stderr.write("Extension '%s' not found. "
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070059 "Some documentation may not build correctly.\n" % extension)
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070060
Davide Pesaventod776a932020-03-20 18:42:36 -040061addExtensionIfExists('sphinxcontrib.doxylink')
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -070062
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070063# The master toctree document.
64master_doc = 'index'
65
Davide Pesaventob310efb2019-04-11 22:10:24 -040066# Add any paths that contain templates here, relative to this directory.
67templates_path = ['_templates']
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070068
69# List of patterns, relative to source directory, that match files and
70# directories to ignore when looking for source files.
Davide Pesaventob310efb2019-04-11 22:10:24 -040071# This pattern also affects html_static_path and html_extra_path.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070072exclude_patterns = []
73
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070074
Davide Pesaventob310efb2019-04-11 22:10:24 -040075# -- Options for HTML output -------------------------------------------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070076
77# The theme to use for HTML and HTML Help pages. See the documentation for
78# a list of builtin themes.
Davide Pesaventob310efb2019-04-11 22:10:24 -040079#
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070080html_theme = 'named_data_theme'
81
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070082# Add any paths that contain custom themes here, relative to this directory.
Davide Pesaventob310efb2019-04-11 22:10:24 -040083html_theme_path = ['.']
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070084
85# Add any paths that contain custom static files (such as style sheets) here,
86# relative to this directory. They are copied after the builtin static files,
87# so a file named "default.css" will overwrite the builtin "default.css".
88html_static_path = ['_static']
89
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070090
Davide Pesaventob310efb2019-04-11 22:10:24 -040091# -- Options for LaTeX output ------------------------------------------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070092
93latex_elements = {
Davide Pesaventob310efb2019-04-11 22:10:24 -040094 # The paper size ('letterpaper' or 'a4paper').
95 #
96 # 'papersize': 'letterpaper',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070097
Davide Pesaventob310efb2019-04-11 22:10:24 -040098 # The font size ('10pt', '11pt' or '12pt').
99 #
100 # 'pointsize': '10pt',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700101
Davide Pesaventob310efb2019-04-11 22:10:24 -0400102 # Additional stuff for the LaTeX preamble.
103 #
104 # 'preamble': '',
105
106 # Latex figure (float) alignment
107 #
108 # 'figure_align': 'htbp',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700109}
110
111# Grouping the document tree into LaTeX files. List of tuples
112# (source start file, target name, title,
113# author, documentclass [howto, manual, or own class]).
114latex_documents = [
Davide Pesaventob310efb2019-04-11 22:10:24 -0400115 ('index', 'ndn-cxx-docs.tex', u'NDN C++ library with eXperimental eXtensions',
116 author, 'manual'),
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700117]
118
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700119
Davide Pesaventob310efb2019-04-11 22:10:24 -0400120# -- Options for manual page output ------------------------------------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700121
122# One entry per manual page. List of tuples
123# (source start file, name, description, authors, manual section).
124man_pages = [
Davide Pesaventob310efb2019-04-11 22:10:24 -0400125 ('manpages/ndnsec', 'ndnsec', 'NDN security toolkit', None, 1),
126 ('manpages/ndnsec-cert-dump', 'ndnsec-cert-dump', 'export an NDN certificate', None, 1),
127 ('manpages/ndnsec-cert-gen', 'ndnsec-cert-gen', 'create an NDN certificate for an identity', None, 1),
128 ('manpages/ndnsec-cert-install', 'ndnsec-cert-install', 'import an NDN certificate from a file', None, 1),
129 ('manpages/ndnsec-delete', 'ndnsec-delete', 'delete an NDN identity, key, or certificate', None, 1),
130 ('manpages/ndnsec-export', 'ndnsec-export', 'export an NDN certificate and its private key to a file', None, 1),
131 ('manpages/ndnsec-get-default', 'ndnsec-get-default', 'show the default NDN identity, key, and certificate for the current user', None, 1),
132 ('manpages/ndnsec-import', 'ndnsec-import', 'import an NDN certificate and its private key from a file', None, 1),
133 ('manpages/ndnsec-key-gen', 'ndnsec-key-gen', 'generate an NDN key for an identity', None, 1),
134 ('manpages/ndnsec-list', 'ndnsec-list', 'list all known NDN identities, keys, and certificates', None, 1),
135 ('manpages/ndnsec-set-default', 'ndnsec-set-default', 'change the default NDN identity, key, or certificate for the current user', None, 1),
136 ('manpages/ndnsec-sign-req', 'ndnsec-sign-req', 'generate an NDN certificate signing request', None, 1),
137 ('manpages/ndnsec-unlock-tpm', 'ndnsec-unlock-tpm', 'unlock the TPM', None, 1),
138 ('manpages/ndn-client.conf', 'ndn-client.conf', 'configuration file for NDN platform', None, 5),
139 ('manpages/ndn-log', 'ndn-log', 'ndn-cxx logging', None, 7),
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700140]
141
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700142# If true, show URL addresses after external links.
Davide Pesaventob310efb2019-04-11 22:10:24 -0400143#man_show_urls = True
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700144
145
Davide Pesaventob310efb2019-04-11 22:10:24 -0400146# -- Custom options ----------------------------------------------------------
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700147
148doxylink = {
Davide Pesaventob310efb2019-04-11 22:10:24 -0400149 'ndn-cxx': ('ndn-cxx.tag', 'doxygen/'),
150}
151
152extlinks = {
153 'issue': ('https://redmine.named-data.net/issues/%s', 'issue #'),
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700154}