Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | # |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 3 | # Configuration file for the Sphinx documentation builder. |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 4 | # |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 5 | # 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 Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 8 | |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 9 | # -- Path setup -------------------------------------------------------------- |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 10 | |
| 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 Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 14 | # |
Davide Pesavento | ab7300b | 2020-04-09 00:51:41 -0400 | [diff] [blame] | 15 | # import os |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 16 | import sys |
| 17 | # sys.path.insert(0, os.path.abspath('.')) |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 18 | |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 19 | |
| 20 | # -- Project information ----------------------------------------------------- |
| 21 | |
| 22 | project = u'ndn-cxx: NDN C++ library with eXperimental eXtensions' |
Davide Pesavento | ab7300b | 2020-04-09 00:51:41 -0400 | [diff] [blame] | 23 | copyright = u'Copyright © 2013-2020 Regents of the University of California.' |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 24 | author = u'Named Data Networking Project' |
| 25 | |
Davide Pesavento | 933a567 | 2020-07-03 22:32:43 -0400 | [diff] [blame^] | 26 | # The short X.Y version. |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 27 | #version = '' |
| 28 | |
Davide Pesavento | 933a567 | 2020-07-03 22:32:43 -0400 | [diff] [blame^] | 29 | # The full version, including alpha/beta/rc tags. |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 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. |
| 36 | today_fmt = '%Y-%m-%d' |
| 37 | |
| 38 | |
| 39 | # -- General configuration --------------------------------------------------- |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 40 | |
| 41 | # If your documentation needs a minimal Sphinx version, state it here. |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 42 | # |
Davide Pesavento | 933a567 | 2020-07-03 22:32:43 -0400 | [diff] [blame^] | 43 | needs_sphinx = '1.3' |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 44 | |
| 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. |
| 48 | extensions = [ |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 49 | 'sphinx.ext.extlinks', |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 50 | 'sphinx.ext.todo', |
| 51 | ] |
| 52 | |
Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 53 | def addExtensionIfExists(extension): |
| 54 | try: |
| 55 | __import__(extension) |
| 56 | extensions.append(extension) |
Alexander Afanasyev | fff47d6 | 2014-05-11 19:24:46 -0700 | [diff] [blame] | 57 | except ImportError: |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 58 | sys.stderr.write("Extension '%s' not found. " |
Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 59 | "Some documentation may not build correctly.\n" % extension) |
Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 60 | |
Davide Pesavento | d776a93 | 2020-03-20 18:42:36 -0400 | [diff] [blame] | 61 | addExtensionIfExists('sphinxcontrib.doxylink') |
Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 62 | |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 63 | # The master toctree document. |
| 64 | master_doc = 'index' |
| 65 | |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 66 | # Add any paths that contain templates here, relative to this directory. |
| 67 | templates_path = ['_templates'] |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 68 | |
| 69 | # List of patterns, relative to source directory, that match files and |
| 70 | # directories to ignore when looking for source files. |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 71 | # This pattern also affects html_static_path and html_extra_path. |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 72 | exclude_patterns = [] |
| 73 | |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 74 | |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 75 | # -- Options for HTML output ------------------------------------------------- |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 76 | |
| 77 | # The theme to use for HTML and HTML Help pages. See the documentation for |
| 78 | # a list of builtin themes. |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 79 | # |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 80 | html_theme = 'named_data_theme' |
| 81 | |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 82 | # Add any paths that contain custom themes here, relative to this directory. |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 83 | html_theme_path = ['.'] |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 84 | |
| 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". |
| 88 | html_static_path = ['_static'] |
| 89 | |
Davide Pesavento | 933a567 | 2020-07-03 22:32:43 -0400 | [diff] [blame^] | 90 | # Disable syntax highlighting of code blocks by default. |
| 91 | highlight_language = 'none' |
| 92 | |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 93 | |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 94 | # -- Options for LaTeX output ------------------------------------------------ |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 95 | |
| 96 | latex_elements = { |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 97 | # The paper size ('letterpaper' or 'a4paper'). |
| 98 | # |
| 99 | # 'papersize': 'letterpaper', |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 100 | |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 101 | # The font size ('10pt', '11pt' or '12pt'). |
| 102 | # |
| 103 | # 'pointsize': '10pt', |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 104 | |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 105 | # Additional stuff for the LaTeX preamble. |
| 106 | # |
| 107 | # 'preamble': '', |
| 108 | |
| 109 | # Latex figure (float) alignment |
| 110 | # |
| 111 | # 'figure_align': 'htbp', |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | # Grouping the document tree into LaTeX files. List of tuples |
| 115 | # (source start file, target name, title, |
| 116 | # author, documentclass [howto, manual, or own class]). |
| 117 | latex_documents = [ |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 118 | ('index', 'ndn-cxx-docs.tex', u'NDN C++ library with eXperimental eXtensions', |
| 119 | author, 'manual'), |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 120 | ] |
| 121 | |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 122 | |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 123 | # -- Options for manual page output ------------------------------------------ |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 124 | |
| 125 | # One entry per manual page. List of tuples |
| 126 | # (source start file, name, description, authors, manual section). |
| 127 | man_pages = [ |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 128 | ('manpages/ndnsec', 'ndnsec', 'NDN security toolkit', None, 1), |
| 129 | ('manpages/ndnsec-cert-dump', 'ndnsec-cert-dump', 'export an NDN certificate', None, 1), |
| 130 | ('manpages/ndnsec-cert-gen', 'ndnsec-cert-gen', 'create an NDN certificate for an identity', None, 1), |
| 131 | ('manpages/ndnsec-cert-install', 'ndnsec-cert-install', 'import an NDN certificate from a file', None, 1), |
| 132 | ('manpages/ndnsec-delete', 'ndnsec-delete', 'delete an NDN identity, key, or certificate', None, 1), |
| 133 | ('manpages/ndnsec-export', 'ndnsec-export', 'export an NDN certificate and its private key to a file', None, 1), |
| 134 | ('manpages/ndnsec-get-default', 'ndnsec-get-default', 'show the default NDN identity, key, and certificate for the current user', None, 1), |
| 135 | ('manpages/ndnsec-import', 'ndnsec-import', 'import an NDN certificate and its private key from a file', None, 1), |
| 136 | ('manpages/ndnsec-key-gen', 'ndnsec-key-gen', 'generate an NDN key for an identity', None, 1), |
| 137 | ('manpages/ndnsec-list', 'ndnsec-list', 'list all known NDN identities, keys, and certificates', None, 1), |
| 138 | ('manpages/ndnsec-set-default', 'ndnsec-set-default', 'change the default NDN identity, key, or certificate for the current user', None, 1), |
| 139 | ('manpages/ndnsec-sign-req', 'ndnsec-sign-req', 'generate an NDN certificate signing request', None, 1), |
| 140 | ('manpages/ndnsec-unlock-tpm', 'ndnsec-unlock-tpm', 'unlock the TPM', None, 1), |
Davide Pesavento | ab7300b | 2020-04-09 00:51:41 -0400 | [diff] [blame] | 141 | ('manpages/ndn-client.conf', 'ndn-client.conf', 'configuration file for NDN applications', None, 5), |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 142 | ('manpages/ndn-log', 'ndn-log', 'ndn-cxx logging', None, 7), |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 143 | ] |
| 144 | |
Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 145 | # If true, show URL addresses after external links. |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 146 | #man_show_urls = True |
Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 147 | |
| 148 | |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 149 | # -- Custom options ---------------------------------------------------------- |
Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 150 | |
| 151 | doxylink = { |
Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 152 | 'ndn-cxx': ('ndn-cxx.tag', 'doxygen/'), |
| 153 | } |
| 154 | |
| 155 | extlinks = { |
| 156 | 'issue': ('https://redmine.named-data.net/issues/%s', 'issue #'), |
Alexander Afanasyev | 9b0e114 | 2014-05-08 00:17:34 -0700 | [diff] [blame] | 157 | } |