blob: 2be118dd9a7cd1907f804c407e13045db879eb13 [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
14import sys, os
15
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.
19#sys.path.insert(0, os.path.abspath('.'))
20
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.
Alexander Afanasyev4cd50e32013-04-22 18:32:31 -070028extensions = [ "sphinx.ext.autodoc", "sphinx.ext.mathjax", "sphinxcontrib.doxylink", "sphinxcontrib.aafig", "sphinxcontrib.googleanalytics", "sphinxcontrib.bibtex" ]
Alexander Afanasyev4d325162012-06-01 12:28:50 -070029
30# Add any paths that contain templates here, relative to this directory.
31templates_path = ['_templates']
32
33# The suffix of source filenames.
34source_suffix = '.rst'
35
36# The encoding of source files.
37#source_encoding = 'utf-8-sig'
38
39# The master toctree document.
Alexander Afanasyevf34fe562013-08-09 17:16:12 -070040master_doc = 'tutorial'
Alexander Afanasyev4d325162012-06-01 12:28:50 -070041
42# General information about the project.
Alexander Afanasyev508269a2012-07-28 13:59:54 -070043project = u''
Alexander Afanasyev9fb2e3d2013-03-30 21:11:07 -070044copyright = u'2011-2013 (c) Alexander Afanasyev, Ilya Moiseenko, and Lixia Zhang'
Alexander Afanasyev4d325162012-06-01 12:28:50 -070045
46# The version info for the project you're documenting, acts as replacement for
47# |version| and |release|, also used in various other places throughout the
48# built documents.
49#
50# The short X.Y version.
Alexander Afanasyev9fb2e3d2013-03-30 21:11:07 -070051version = '0.2.8'
Alexander Afanasyev4d325162012-06-01 12:28:50 -070052# The full version, including alpha/beta/rc tags.
Alexander Afanasyev8a53f762012-07-28 14:12:37 -070053release = 'Overall ndnSIM'
Alexander Afanasyev4d325162012-06-01 12:28:50 -070054
55# The language for content autogenerated by Sphinx. Refer to documentation
56# for a list of supported languages.
57#language = None
58
59# There are two options for replacing |today|: either, you set today to some
60# non-false value, then it is used:
61#today = ''
62# Else, today_fmt is used as the format for a strftime call.
63#today_fmt = '%B %d, %Y'
64
65# List of patterns, relative to source directory, that match files and
66# directories to ignore when looking for source files.
67exclude_patterns = []
68
69# The reST default role (used for this markup: `text`) to use for all documents.
70#default_role = None
71
72# If true, '()' will be appended to :func: etc. cross-reference text.
73#add_function_parentheses = True
74
75# If true, the current module name will be prepended to all description
76# unit titles (such as .. function::).
77#add_module_names = True
78
79# If true, sectionauthor and moduleauthor directives will be shown in the
80# output. They are ignored by default.
81#show_authors = False
82
83# The name of the Pygments (syntax highlighting) style to use.
84pygments_style = 'sphinx'
85
86# A list of ignored prefixes for module index sorting.
87#modindex_common_prefix = []
88
89
90# -- Options for HTML output ---------------------------------------------------
91
92# The theme to use for HTML and HTML Help pages. See the documentation for
93# a list of builtin themes.
Alexander Afanasyev508269a2012-07-28 13:59:54 -070094html_theme = 'ns3_html_theme'
Alexander Afanasyev4d325162012-06-01 12:28:50 -070095
96# Theme options are theme-specific and customize the look and feel of a theme
97# further. For a list of options available for each theme, see the
98# documentation.
99#html_theme_options = {}
100
101# Add any paths that contain custom themes here, relative to this directory.
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700102html_theme_path = ["../"]
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700103
104# The name for this set of Sphinx documents. If None, it defaults to
105# "<project> v<release> documentation".
106#html_title = None
107
108# A shorter title for the navigation bar. Default is the same as html_title.
109#html_short_title = None
110
111# The name of an image file (relative to this directory) to place at the top
112# of the sidebar.
113#html_logo = None
114
115# The name of an image file (within the static path) to use as favicon of the
116# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
117# pixels large.
118#html_favicon = None
119
120# Add any paths that contain custom static files (such as style sheets) here,
121# relative to this directory. They are copied after the builtin static files,
122# so a file named "default.css" will overwrite the builtin "default.css".
123html_static_path = ['_static']
124
125# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
126# using the given strftime format.
127#html_last_updated_fmt = '%b %d, %Y'
128
129# If true, SmartyPants will be used to convert quotes and dashes to
130# typographically correct entities.
131#html_use_smartypants = True
132
133# Custom sidebar templates, maps document names to template names.
134#html_sidebars = {}
135
136# Additional templates that should be rendered to pages, maps page names to
137# template names.
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700138html_additional_pages = {
139 'index': 'indexcontent.html',
140}
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700141
142# If false, no module index is generated.
Alexander Afanasyev462bb212012-11-24 16:42:53 -0800143html_domain_indices = False
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700144
145# If false, no index is generated.
Alexander Afanasyev462bb212012-11-24 16:42:53 -0800146html_use_index = False
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700147
148# If true, the index is split into individual pages for each letter.
149#html_split_index = False
150
151# If true, links to the reST sources are added to the pages.
152#html_show_sourcelink = True
153
154# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
155#html_show_sphinx = True
156
157# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
158#html_show_copyright = True
159
160# If true, an OpenSearch description file will be output, and all pages will
161# contain a <link> tag referring to it. The value of this option must be the
162# base URL from which the finished HTML is served.
163#html_use_opensearch = ''
164
165# This is the file name suffix for HTML files (e.g. ".xhtml").
166#html_file_suffix = None
167
168# Output file base name for HTML help builder.
169htmlhelp_basename = 'ndnSIMNS-3basedNDNsimulatordoc'
170
171
172# -- Options for LaTeX output --------------------------------------------------
173
174latex_elements = {
175# The paper size ('letterpaper' or 'a4paper').
176#'papersize': 'letterpaper',
177
178# The font size ('10pt', '11pt' or '12pt').
179#'pointsize': '10pt',
180
181# Additional stuff for the LaTeX preamble.
182#'preamble': '',
183}
184
185# Grouping the document tree into LaTeX files. List of tuples
186# (source start file, target name, title, author, documentclass [howto/manual]).
187latex_documents = [
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700188 ('index', 'ndnSIM.tex', u'ndnSIM: NS-3 based Named Data Networking (NDN) simulator documentation',
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700189 u'Alexander Afanasyev, Ilya Moiseenko, and Lixia Zhang', 'manual'),
190]
191
192# The name of an image file (relative to this directory) to place at the top of
193# the title page.
194#latex_logo = None
195
196# For "manual" documents, if this is true, then toplevel headings are parts,
197# not chapters.
198#latex_use_parts = False
199
200# If true, show page references after internal links.
201#latex_show_pagerefs = False
202
203# If true, show URL addresses after external links.
204#latex_show_urls = False
205
206# Documents to append as an appendix to all manuals.
207#latex_appendices = []
208
209# If false, no module index is generated.
Alexander Afanasyev462bb212012-11-24 16:42:53 -0800210latex_domain_indices = False
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700211
212
213# -- Options for manual page output --------------------------------------------
214
215# One entry per manual page. List of tuples
216# (source start file, name, description, authors, manual section).
217man_pages = [
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700218 ('index', 'ndnSIM', u'ndnSIM: NS-3 based Named Data Networking (NDN) simulator documentation',
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700219 [u'Alexander Afanasyev, Ilya Moiseenko, and Lixia Zhang'], 1)
220]
221
222# If true, show URL addresses after external links.
223#man_show_urls = False
224
225
226# -- Options for Texinfo output ------------------------------------------------
227
228# Grouping the document tree into Texinfo files. List of tuples
229# (source start file, target name, title, author,
230# dir menu entry, description, category)
231texinfo_documents = [
Alexander Afanasyevf34fe562013-08-09 17:16:12 -0700232 ('index', 'ndnSIM', u'ndnSIM: NS-3 based Named Data Networking (NDN) simulator documentation',
233 u'Alexander Afanasyev, Ilya Moiseenko, and Lixia Zhang', 'ndnSIM', 'One line description of project.',
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700234 'Miscellaneous'),
235]
236
237# Documents to append as an appendix to all manuals.
238#texinfo_appendices = []
239
240# If false, no module index is generated.
Alexander Afanasyev462bb212012-11-24 16:42:53 -0800241texinfo_domain_indices = False
Alexander Afanasyev4d325162012-06-01 12:28:50 -0700242
243# How to display URL addresses: 'footnote', 'no', or 'inline'.
244#texinfo_show_urls = 'footnote'
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700245
246doxylink = {
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700247 'ndnsim' : ('ndnSIM.tag', 'doxygen/'),
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700248}
249
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700250googleanalytics_id = "UA-21372502-8"
251
252googleanalytics_enabled = True
253
Alexander Afanasyevaa1c4c32012-11-21 16:17:03 -0800254# aafig_format = dict(latex='pdf', html='png', text=None)
255
256# aafig_default_options = dict(Fixed=True)