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