Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 1 | # Configuration file for the Sphinx documentation builder. |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 2 | # |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 3 | # This file only contains a selection of the most common options. For a full |
| 4 | # list see the documentation: |
Davide Pesavento | 7ae8b08 | 2021-10-12 21:45:47 -0400 | [diff] [blame^] | 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 6 | |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 7 | # -- Path setup -------------------------------------------------------------- |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 8 | |
| 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 Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 12 | # |
| 13 | # import os |
| 14 | import sys |
| 15 | # sys.path.insert(0, os.path.abspath('.')) |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 16 | |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 17 | |
| 18 | # -- Project information ----------------------------------------------------- |
| 19 | |
| 20 | project = u'Named Data Link State Routing Protocol (NLSR)' |
Davide Pesavento | 7ae8b08 | 2021-10-12 21:45:47 -0400 | [diff] [blame^] | 21 | copyright = u'Copyright © 2014-2021 Named Data Networking Project.' |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 22 | author = u'Named Data Networking Project' |
| 23 | |
Davide Pesavento | 7ae8b08 | 2021-10-12 21:45:47 -0400 | [diff] [blame^] | 24 | # The short X.Y version. |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 25 | #version = '' |
| 26 | |
Davide Pesavento | 7ae8b08 | 2021-10-12 21:45:47 -0400 | [diff] [blame^] | 27 | # The full version, including alpha/beta/rc tags. |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 28 | #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. |
| 34 | today_fmt = '%Y-%m-%d' |
| 35 | |
| 36 | |
| 37 | # -- General configuration --------------------------------------------------- |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 38 | |
| 39 | # If your documentation needs a minimal Sphinx version, state it here. |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 40 | # |
Davide Pesavento | 7ae8b08 | 2021-10-12 21:45:47 -0400 | [diff] [blame^] | 41 | needs_sphinx = '1.3' |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 42 | |
| 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. |
| 46 | extensions = [ |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 47 | 'sphinx.ext.extlinks', |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 48 | 'sphinx.ext.todo', |
| 49 | ] |
| 50 | |
Alexander Afanasyev | 7decbbf | 2014-08-24 21:29:01 -0700 | [diff] [blame] | 51 | def addExtensionIfExists(extension): |
| 52 | try: |
| 53 | __import__(extension) |
| 54 | extensions.append(extension) |
| 55 | except ImportError: |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 56 | sys.stderr.write("Extension '%s' not found. " |
Alexander Afanasyev | 7decbbf | 2014-08-24 21:29:01 -0700 | [diff] [blame] | 57 | "Some documentation may not build correctly.\n" % extension) |
Alexander Afanasyev | 7decbbf | 2014-08-24 21:29:01 -0700 | [diff] [blame] | 58 | |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 59 | addExtensionIfExists('sphinxcontrib.doxylink') |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 60 | |
| 61 | # The master toctree document. |
| 62 | master_doc = 'index' |
| 63 | |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 64 | # Add any paths that contain templates here, relative to this directory. |
| 65 | templates_path = ['_templates'] |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 66 | |
| 67 | # List of patterns, relative to source directory, that match files and |
| 68 | # directories to ignore when looking for source files. |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 69 | # This pattern also affects html_static_path and html_extra_path. |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 70 | exclude_patterns = [] |
| 71 | |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 72 | |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 73 | # -- Options for HTML output ------------------------------------------------- |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 74 | |
| 75 | # The theme to use for HTML and HTML Help pages. See the documentation for |
| 76 | # a list of builtin themes. |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 77 | # |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 78 | html_theme = 'named_data_theme' |
| 79 | |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 80 | # Add any paths that contain custom themes here, relative to this directory. |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 81 | html_theme_path = ['.'] |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 82 | |
| 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". |
| 86 | html_static_path = ['_static'] |
| 87 | |
Davide Pesavento | 7ae8b08 | 2021-10-12 21:45:47 -0400 | [diff] [blame^] | 88 | html_copy_source = False |
| 89 | html_show_sourcelink = False |
| 90 | |
| 91 | # Disable syntax highlighting of code blocks by default. |
| 92 | highlight_language = 'none' |
| 93 | |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 94 | |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 95 | # -- Options for LaTeX output ------------------------------------------------ |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 96 | |
| 97 | latex_elements = { |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 98 | # The paper size ('letterpaper' or 'a4paper'). |
| 99 | # |
| 100 | # 'papersize': 'letterpaper', |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 101 | |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 102 | # The font size ('10pt', '11pt' or '12pt'). |
| 103 | # |
| 104 | # 'pointsize': '10pt', |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 105 | |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 106 | # Additional stuff for the LaTeX preamble. |
| 107 | # |
| 108 | # 'preamble': '', |
| 109 | |
| 110 | # Latex figure (float) alignment |
| 111 | # |
| 112 | # 'figure_align': 'htbp', |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 113 | } |
| 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]). |
| 118 | latex_documents = [ |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 119 | ('index', 'nlsr-docs.tex', u'Named Data Link State Routing Protocol (NLSR)', |
| 120 | author, 'manual'), |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 121 | ] |
| 122 | |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 123 | |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 124 | # -- Options for manual page output ------------------------------------------ |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 125 | |
| 126 | # One entry per manual page. List of tuples |
| 127 | # (source start file, name, description, authors, manual section). |
| 128 | man_pages = [ |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 129 | ('manpages/nlsr', 'nlsr', u'Named Data Link State Routing daemon', None, 1), |
| 130 | ('manpages/nlsr.conf', 'nlsr.conf', u'Named Data Link State Routing daemon configuration file', None, 5), |
| 131 | ('manpages/nlsrc', 'nlsrc', u'command-line utility to interact with and collect statistics from NLSR', None, 1), |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 132 | ] |
| 133 | |
Vince Lehman | b722b10 | 2014-08-24 16:33:49 -0500 | [diff] [blame] | 134 | # If true, show URL addresses after external links. |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 135 | #man_show_urls = True |
Alexander Afanasyev | 7decbbf | 2014-08-24 21:29:01 -0700 | [diff] [blame] | 136 | |
Vince Lehman | de5560c | 2015-04-29 17:18:51 -0500 | [diff] [blame] | 137 | |
Davide Pesavento | f6be8e3 | 2020-04-30 16:06:03 -0400 | [diff] [blame] | 138 | # -- Custom options ---------------------------------------------------------- |
| 139 | |
| 140 | doxylink = { |
| 141 | 'nlsr': ('NLSR.tag', 'doxygen/'), |
| 142 | } |
| 143 | |
| 144 | extlinks = { |
| 145 | 'issue': ('https://redmine.named-data.net/issues/%s', 'issue #'), |
| 146 | } |