blob: 8bdfd9fd493a87b7fd2d9e3c864a3cfa672b067b [file] [log] [blame]
Alexander Afanasyev4d325162012-06-01 12:28:50 -07001# -*- coding: utf-8 -*-
2#
3# ndnSIM: NS-3 based NDN simulator documentation build configuration file, created by
4# sphinx-quickstart on Thu May 31 18:21:13 2012.
5#
6# This file is execfile()d with the current directory set to its containing dir.
7#
8# Note that not all possible configuration values are present in this
9# autogenerated file.
10#
11# All configuration values have a default; values that are commented out
12# serve to show the default.
13
Spyridon Mastorakis5897c962015-08-31 15:37:18 -070014import sys, os, re
Alexander Afanasyev4d325162012-06-01 12:28:50 -070015
16# If extensions (or modules to document with autodoc) are in another directory,
17# add these directories to sys.path here. If the directory is relative to the
18# documentation root, use os.path.abspath to make it absolute, like shown here.
Spyridon Mastorakis5897c962015-08-31 15:37:18 -070019sys.path.insert(0, os.path.abspath('..'))
Alexander Afanasyev4d325162012-06-01 12:28:50 -070020
21# -- General configuration -----------------------------------------------------
22
23# If your documentation needs a minimal Sphinx version, state it here.
24#needs_sphinx = '1.0'
25
26# Add any Sphinx extension module names here, as strings. They can be extensions
27# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
Spyridon Mastorakis5897c962015-08-31 15:37:18 -070028extensions = [
29 'sphinx.ext.autodoc',
30 'sphinx.ext.mathjax',
31 'sphinxcontrib.doxylink',
32 'sphinxcontrib.aafig',
Alexander Afanasyev40b88332019-02-13 16:19:06 -050033 'sphinxcontrib.googleanalytics',
Spyridon Mastorakis5897c962015-08-31 15:37:18 -070034 'sphinxcontrib.bibtex',
35 'redmine_issue'
36]
Alexander Afanasyev4d325162012-06-01 12:28:50 -070037
Spyridon Mastorakis5897c962015-08-31 15:37:18 -070038# def addExtensionIfExists(extension):
39# try:
40# __import__(extension)
41# extensions.append(extension)
42# except ImportError:
43# sys.stderr.write("Extension '%s' in not available. "
44# "Some documentation may not build correctly.\n" % extension)
45# sys.stderr.write("To install, use \n"
46# " sudo pip install %s\n" % extension.replace('.', '-'))
47
48# addExtensionIfExists('sphinxcontrib.doxylink')
49
50# if os.getenv('GOOGLE_ANALYTICS', None):
51# addExtensionIfExists('sphinxcontrib.googleanalytics')
52
Spyridon Mastorakisa879e022017-10-16 17:12:14 -070053
Alexander Afanasyev4d325162012-06-01 12:28:50 -070054# Add any paths that contain templates here, relative to this directory.
55templates_path = ['_templates']
56
57# The suffix of source filenames.
58source_suffix = '.rst'
59
60# The encoding of source files.
61#source_encoding = 'utf-8-sig'
62
63# The master toctree document.
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070064master_doc = 'tutorial'
Alexander Afanasyev4d325162012-06-01 12:28:50 -070065
66# General information about the project.
Alexander Afanasyev508269a2012-07-28 13:59:54 -070067project = u''
Spyridon Mastorakisa879e022017-10-16 17:12:14 -070068copyright = u'2011-2017 (c) Alexander Afanasyev, Spyridon Mastorakis, Ilya Moiseenko, and Lixia Zhang'
Alexander Afanasyev4d325162012-06-01 12:28:50 -070069
70# The version info for the project you're documenting, acts as replacement for
71# |version| and |release|, also used in various other places throughout the
72# built documents.
73#
74# The short X.Y version.
Spyridon Mastorakisa879e022017-10-16 17:12:14 -070075version = '2.4'
Alexander Afanasyev4d325162012-06-01 12:28:50 -070076# The full version, including alpha/beta/rc tags.
Alexander Afanasyev5dee3612015-08-25 16:09:04 -070077release = 'ndnSIM'
Alexander Afanasyev4d325162012-06-01 12:28:50 -070078
79# The language for content autogenerated by Sphinx. Refer to documentation
80# for a list of supported languages.
81#language = None
82
83# There are two options for replacing |today|: either, you set today to some
84# non-false value, then it is used:
85#today = ''
86# Else, today_fmt is used as the format for a strftime call.
87#today_fmt = '%B %d, %Y'
88
89# List of patterns, relative to source directory, that match files and
90# directories to ignore when looking for source files.
91exclude_patterns = []
92
93# The reST default role (used for this markup: `text`) to use for all documents.
94#default_role = None
95
96# If true, '()' will be appended to :func: etc. cross-reference text.
97#add_function_parentheses = True
98
99# If true, the current module name will be prepended to all description
100# unit titles (such as .. function::).
101#add_module_names = True
102
103# If true, sectionauthor and moduleauthor directives will be shown in the
104# output. They are ignored by default.
105#show_authors = False
106
107# The name of the Pygments (syntax highlighting) style to use.
108pygments_style = 'sphinx'
109
110# A list of ignored prefixes for module index sorting.
111#modindex_common_prefix = []
112
113
114# -- Options for HTML output ---------------------------------------------------
115
116# The theme to use for HTML and HTML Help pages. See the documentation for
117# a list of builtin themes.
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700118html_theme = 'ns3_html_theme'
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700119
120# Theme options are theme-specific and customize the look and feel of a theme
121# further. For a list of options available for each theme, see the
122# documentation.
123#html_theme_options = {}
124
125# Add any paths that contain custom themes here, relative to this directory.
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700126html_theme_path = ["../"]
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700127
128# The name for this set of Sphinx documents. If None, it defaults to
129# "<project> v<release> documentation".
130#html_title = None
131
132# A shorter title for the navigation bar. Default is the same as html_title.
133#html_short_title = None
134
135# The name of an image file (relative to this directory) to place at the top
136# of the sidebar.
137#html_logo = None
138
139# The name of an image file (within the static path) to use as favicon of the
140# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
141# pixels large.
142#html_favicon = None
143
144# Add any paths that contain custom static files (such as style sheets) here,
145# relative to this directory. They are copied after the builtin static files,
146# so a file named "default.css" will overwrite the builtin "default.css".
147html_static_path = ['_static']
148
149# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
150# using the given strftime format.
151#html_last_updated_fmt = '%b %d, %Y'
152
153# If true, SmartyPants will be used to convert quotes and dashes to
154# typographically correct entities.
155#html_use_smartypants = True
156
157# Custom sidebar templates, maps document names to template names.
158#html_sidebars = {}
159
160# Additional templates that should be rendered to pages, maps page names to
161# template names.
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700162html_additional_pages = {
163 'index': 'indexcontent.html',
164}
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700165
166# If false, no module index is generated.
Alexander Afanasyev462bb212012-11-24 16:42:53 -0800167html_domain_indices = False
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700168
169# If false, no index is generated.
Alexander Afanasyev462bb212012-11-24 16:42:53 -0800170html_use_index = False
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700171
172# If true, the index is split into individual pages for each letter.
173#html_split_index = False
174
175# If true, links to the reST sources are added to the pages.
176#html_show_sourcelink = True
177
178# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
179#html_show_sphinx = True
180
181# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
182#html_show_copyright = True
183
184# If true, an OpenSearch description file will be output, and all pages will
185# contain a <link> tag referring to it. The value of this option must be the
186# base URL from which the finished HTML is served.
187#html_use_opensearch = ''
188
189# This is the file name suffix for HTML files (e.g. ".xhtml").
190#html_file_suffix = None
191
192# Output file base name for HTML help builder.
193htmlhelp_basename = 'ndnSIMNS-3basedNDNsimulatordoc'
194
195
196# -- Options for LaTeX output --------------------------------------------------
197
198latex_elements = {
199# The paper size ('letterpaper' or 'a4paper').
200#'papersize': 'letterpaper',
201
202# The font size ('10pt', '11pt' or '12pt').
203#'pointsize': '10pt',
204
205# Additional stuff for the LaTeX preamble.
206#'preamble': '',
207}
208
209# Grouping the document tree into LaTeX files. List of tuples
210# (source start file, target name, title, author, documentclass [howto/manual]).
211latex_documents = [
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700212 ('tutorial', 'ndnSIM-tutorial.tex', u'ndnSIM: NS-3 based Named Data Networking (NDN) simulator documentation',
Spyridon Mastorakis47a60922015-01-10 19:40:11 -0800213 u'Alexander Afanasyev, Spyridon Mastorakis, Ilya Moiseenko, and Lixia Zhang', 'manual'),
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700214]
215
216# The name of an image file (relative to this directory) to place at the top of
217# the title page.
218#latex_logo = None
219
220# For "manual" documents, if this is true, then toplevel headings are parts,
221# not chapters.
222#latex_use_parts = False
223
224# If true, show page references after internal links.
225#latex_show_pagerefs = False
226
227# If true, show URL addresses after external links.
228#latex_show_urls = False
229
230# Documents to append as an appendix to all manuals.
231#latex_appendices = []
232
233# If false, no module index is generated.
Alexander Afanasyev462bb212012-11-24 16:42:53 -0800234latex_domain_indices = False
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700235
236
237# -- Options for manual page output --------------------------------------------
238
239# One entry per manual page. List of tuples
240# (source start file, name, description, authors, manual section).
241man_pages = [
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700242 ('index', 'ndnSIM', u'ndnSIM: NS-3 based Named Data Networking (NDN) simulator documentation',
Spyridon Mastorakis47a60922015-01-10 19:40:11 -0800243 [u'Alexander Afanasyev, Spyridon Mastorakis, Ilya Moiseenko, and Lixia Zhang'], 1)
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700244]
245
246# If true, show URL addresses after external links.
247#man_show_urls = False
248
249
250# -- Options for Texinfo output ------------------------------------------------
251
252# Grouping the document tree into Texinfo files. List of tuples
253# (source start file, target name, title, author,
254# dir menu entry, description, category)
255texinfo_documents = [
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700256 ('index', 'ndnSIM', u'ndnSIM: NS-3 based Named Data Networking (NDN) simulator documentation',
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800257 u'Alexander Afanasyev, Spyridon Mastorakis, Ilya Moiseenko, and Lixia Zhang', 'ndnSIM', 'One line description of project.',
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700258 'Miscellaneous'),
259]
260
261# Documents to append as an appendix to all manuals.
262#texinfo_appendices = []
263
264# If false, no module index is generated.
Alexander Afanasyev462bb212012-11-24 16:42:53 -0800265texinfo_domain_indices = False
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700266
267# How to display URL addresses: 'footnote', 'no', or 'inline'.
268#texinfo_show_urls = 'footnote'
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700269
270doxylink = {
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700271 'ndnsim' : ('ndnSIM.tag', 'doxygen/'),
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800272 'nfd' : ('ndnSIM.tag', 'doxygen/'),
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700273}
274
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700275googleanalytics_id = "UA-21372502-8"
276
277googleanalytics_enabled = True
278
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800279aafig_format = {'latex': 'pdf', 'html': 'svg', 'text': None}
Alexander Afanasyevaa1c4c32012-11-21 16:17:03 -0800280
281# aafig_default_options = dict(Fixed=True)
Spyridon Mastorakis5897c962015-08-31 15:37:18 -0700282
283redmine_project_url = "http://redmine.named-data.net/"