build: update waf to version 2.0.6
Major cleanup of all build scripts
Change-Id: I6904f034d40adc66366fdf08749900ffb31c68d9
diff --git a/docs/_static/.gitignore b/docs/_static/.gitignore
deleted file mode 100644
index e69de29..0000000
--- a/docs/_static/.gitignore
+++ /dev/null
diff --git a/docs/conf.py b/docs/conf.py
index 6cf5ccb..0e7d000 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
#
-# NFD - Named Data Networking Forwarding Daemon documentation build configuration file, created by
-# sphinx-quickstart on Sun Apr 6 19:58:22 2014.
+# NFD documentation build configuration file, created by
+# sphinx-quickstart on Wed Mar 7 19:23:56 2018.
#
# This file is execfile()d with the current directory set to its
# containing dir.
@@ -21,10 +21,12 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('.'))
+
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+#
+# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -46,149 +48,79 @@
addExtensionIfExists('sphinxcontrib.doxylink')
-if os.getenv('GOOGLE_ANALYTICS', None):
- addExtensionIfExists('sphinxcontrib.googleanalytics')
+# sphinxcontrib.googleanalytics is currently not working with the latest version of Sphinx
+# if os.getenv('GOOGLE_ANALYTICS', None):
+# addExtensionIfExists('sphinxcontrib.googleanalytics')
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
-# The suffix of source filenames.
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'NFD - Named Data Networking Forwarding Daemon'
copyright = u'2014-%d, Named Data Networking Project' % datetime.date.today().year
+author = u'Named Data Networking Project'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
+#
+# The short X.Y version.
+# version = u''
+# The full version, including alpha/beta/rc tags.
+# release = u''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-# html_theme = 'default'
+#
+# html_theme = 'alabaster'
html_theme = 'named_data_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
+#
+# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = ['./']
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
+html_theme_path = ['.']
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-#html_extra_path = []
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-html_file_suffix = ".html"
+# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'nfd-docs'
@@ -197,80 +129,68 @@
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- ('index', 'nfd-docs.tex', u'NFD - Named Data Networking Forwarding Daemon Documentation',
- u'Named Data Networking Project', 'manual'),
+ ('index', 'nfd-docs.tex', u'NFD - Named Data Networking Forwarding Daemon Documentation',
+ u'Named Data Networking Project', 'manual'),
]
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('manpages/nfd', 'nfd', u'Named Data Networking Forwarding Daemon', None, 1),
- ('manpages/nfdc', 'nfdc', u'interact with NFD management', None, 1),
- ('manpages/nfdc-status', 'nfdc-status', u'show NFD status', None, 1),
- ('manpages/nfdc-face', 'nfdc-face', u'show and manipulate NFD faces', None, 1),
- ('manpages/nfdc-route', 'nfdc-route', u'show and manipulate NFD routes', None, 1),
- ('manpages/nfdc-cs', 'nfdc-cs', u'show and manipulate NFD Content Store', None, 1),
- ('manpages/nfdc-strategy', 'nfdc-strategy', u'show and manipulate NFD strategy choices', None, 1),
- ('manpages/nfd-status', 'nfd-status', u'comprehensive report of NFD status', None, 1),
- ('manpages/nfd-status-http-server', 'nfd-status-http-server',
- u'NFD status HTTP server', None, 1),
- ('manpages/ndn-autoconfig-server', 'ndn-autoconfig-server',
- u'NDN auto-configuration server', None, 1),
- ('manpages/ndn-autoconfig', 'ndn-autoconfig',
- u'NDN auto-configuration client', None, 1),
- ('manpages/ndn-autoconfig.conf', 'ndn-autoconfig.conf',
- u'NDN auto-configuration client configuration file', None, 5),
- ('manpages/nfd-autoreg', 'nfd-autoreg', u'NFD Auto-registration Server', None, 1),
- ('manpages/nfd-asf-strategy', 'nfd-asf-strategy', u'NFD ASF Strategy', None, 7),
+ ('manpages/nfd', 'nfd', u'Named Data Networking Forwarding Daemon', '', 1),
+ ('manpages/nfdc', 'nfdc', u'Interact with NFD management', '', 1),
+ ('manpages/nfdc-status', 'nfdc-status', u'Show NFD status', '', 1),
+ ('manpages/nfdc-face', 'nfdc-face', u'Show and manipulate NFD faces', '', 1),
+ ('manpages/nfdc-route', 'nfdc-route', u'Show and manipulate NFD routes', '', 1),
+ ('manpages/nfdc-cs', 'nfdc-cs', u'Show and manipulate NFD Content Store', '', 1),
+ ('manpages/nfdc-strategy', 'nfdc-strategy', u'Show and manipulate NFD strategy choices', '', 1),
+ ('manpages/nfd-status', 'nfd-status', u'Comprehensive report of NFD status', '', 1),
+ ('manpages/nfd-status-http-server', 'nfd-status-http-server', u'NFD status HTTP server', '', 1),
+ ('manpages/ndn-autoconfig-server', 'ndn-autoconfig-server', u'NDN auto-configuration server', '', 1),
+ ('manpages/ndn-autoconfig', 'ndn-autoconfig', u'NDN auto-configuration client', '', 1),
+ ('manpages/ndn-autoconfig.conf', 'ndn-autoconfig.conf', u'NDN auto-configuration client configuration file', '', 5),
+ ('manpages/nfd-autoreg', 'nfd-autoreg', u'NFD auto-registration server', '', 1),
+ ('manpages/nfd-asf-strategy', 'nfd-asf-strategy', u'NFD ASF strategy', '', 7),
]
-# If true, show URL addresses after external links.
-#man_show_urls = False
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = []
+
doxylink = {
- 'nfd' : ('NFD.tag', 'doxygen/'),
+ 'nfd' : ('NFD.tag', 'doxygen/'),
}
if os.getenv('GOOGLE_ANALYTICS', None):
googleanalytics_id = os.environ['GOOGLE_ANALYTICS']
googleanalytics_enabled = True
-redmine_project_url = "https://redmine.named-data.net/"
+redmine_project_url = 'https://redmine.named-data.net/'
diff --git a/docs/index.rst b/docs/index.rst
index 4903931..0c5094e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,9 +2,8 @@
=============================================
NFD is a network forwarder that implements and evolves together with the Named Data
-Networking (NDN) `protocol <https://named-data.net/doc/ndn-tlv/>`__. After the initial
-release, NFD will become a core component of the `NDN Platform
-<https://named-data.net/codebase/platform/>`__ and will follow the same release cycle.
+Networking (NDN) `protocol <https://named-data.net/doc/ndn-tlv/>`__. NFD is a core
+component of the `NDN Platform <https://named-data.net/codebase/platform/>`__.
NFD Documentation
-----------------