From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama500.ecl.ntt.co.jp (tama500.ecl.ntt.co.jp [129.60.39.148]) by dpdk.org (Postfix) with ESMTP id 80BB81B1AA for ; Mon, 5 Feb 2018 03:35:48 +0100 (CET) Received: from vc1.ecl.ntt.co.jp (vc1.ecl.ntt.co.jp [129.60.86.153]) by tama500.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id w152ZkDU016924; Mon, 5 Feb 2018 11:35:46 +0900 Received: from vc1.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id B00DEEA78CD; Mon, 5 Feb 2018 11:35:46 +0900 (JST) Received: from jcms-pop21.ecl.ntt.co.jp (jcms-pop21.ecl.ntt.co.jp [129.60.87.134]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id A53DDEA7856; Mon, 5 Feb 2018 11:35:46 +0900 (JST) Received: from [IPv6:::1] (watercress.nslab.ecl.ntt.co.jp [129.60.13.73]) by jcms-pop21.ecl.ntt.co.jp (Postfix) with ESMTPSA id 9C3F440081E; Mon, 5 Feb 2018 11:35:46 +0900 (JST) References: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp> From: Yasufumi Ogawa Message-ID: <2e57d878-0f51-967a-d1dd-38e1d02492e8@lab.ntt.co.jp> Date: Mon, 5 Feb 2018 11:34:29 +0900 User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.4.0 MIME-Version: 1.0 In-Reply-To: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 8bit X-CC-Mail-RelayStamp: 1 To: spp@dpdk.org, ferruh.yigit@intel.com, nakamura.hiroyuki@po.ntt-tx.co.jp X-TM-AS-MML: disable Subject: Re: [spp] [PATCH 01/15] docs: add rst docs X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 05 Feb 2018 02:35:49 -0000 Hi, Ferruh I completed to migrate markdown documents to RST and prepare patches. Could you merge this 15 patches, then next patches I will send after this mail. This update includes spp_vf documentation sent from Hiroyuki. Thanks, Yasufumi On 2018/02/01 13:04, ogawa.yasufumi@lab.ntt.co.jp wrote: > From: Yasufumi Ogawa > > This is the first commit to move markdown documents to rst. > > Current documents are moved to each of directories of category. Top > directory of rst files is 'guides' which contains three category > directories, 'commands', 'setup' and 'tools'. > > docs/guides/ > ├── commands > ├── index.rst > ├── overview.rst > ├── setup > │   ├── index.rst > │   └── setup_guide.rst > └── tools > > Signed-off-by: Yasufumi Ogawa > --- > docs/guides/Makefile | 20 +++++ > docs/guides/conf.py | 165 ++++++++++++++++++++++++++++++++++++++ > docs/guides/index.rst | 40 +++++++++ > docs/guides/setup/index.rst | 38 +++++++++ > docs/guides/setup/setup_guide.rst | 38 +++++++++ > 5 files changed, 301 insertions(+) > create mode 100644 docs/guides/Makefile > create mode 100644 docs/guides/conf.py > create mode 100644 docs/guides/index.rst > create mode 100644 docs/guides/setup/index.rst > create mode 100644 docs/guides/setup/setup_guide.rst > > diff --git a/docs/guides/Makefile b/docs/guides/Makefile > new file mode 100644 > index 0000000..361a6cc > --- /dev/null > +++ b/docs/guides/Makefile > @@ -0,0 +1,20 @@ > +# Minimal makefile for Sphinx documentation > +# > + > +# You can set these variables from the command line. > +SPHINXOPTS = > +SPHINXBUILD = sphinx-build > +SPHINXPROJ = SoftPatchPanel > +SOURCEDIR = . > +BUILDDIR = _build > + > +# Put it first so that "make" without argument is like "make help". > +help: > + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) > + > +.PHONY: help Makefile > + > +# Catch-all target: route all unknown targets to Sphinx using the new > +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). > +%: Makefile > + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) > \ No newline at end of file > diff --git a/docs/guides/conf.py b/docs/guides/conf.py > new file mode 100644 > index 0000000..5a645fb > --- /dev/null > +++ b/docs/guides/conf.py > @@ -0,0 +1,165 @@ > +# -*- coding: utf-8 -*- > +# > +# Soft Patch Panel documentation build configuration file, created by > +# sphinx-quickstart on Thu Jan 25 13:52:03 2018. > +# > +# This file is execfile()d with the current directory set to its > +# containing dir. > +# > +# Note that not all possible configuration values are present in this > +# autogenerated file. > +# > +# All configuration values have a default; values that are commented out > +# serve to show the default. > + > +# If extensions (or modules to document with autodoc) are in another directory, > +# add these directories to sys.path here. If the directory is relative to the > +# documentation root, use os.path.abspath to make it absolute, like shown here. > +# > +# import os > +# import sys > +# sys.path.insert(0, os.path.abspath('.')) > + > + > +# -- General configuration ------------------------------------------------ > + > +# If your documentation needs a minimal Sphinx version, state it here. > +# > +# 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 > +# ones. > +extensions = [] > + > +# Add any paths that contain templates here, relative to this directory. > +templates_path = ['_templates'] > + > +# The suffix(es) of source filenames. > +# You can specify multiple suffix as a list of string: > +# > +# source_suffix = ['.rst', '.md'] > +source_suffix = '.rst' > + > +# The master toctree document. > +master_doc = 'index' > + > +# General information about the project. > +project = u'Soft Patch Panel' > +copyright = u'2018, Yasufumi Ogawa' > +author = u'Yasufumi Ogawa' > + > +# 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'v17.11' > +# The full version, including alpha/beta/rc tags. > +release = u'v17.11' > + > +# The language for content autogenerated by Sphinx. Refer to documentation > +# for a list of supported languages. > +# > +# 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 = ['_build', 'Thumbs.db', '.DS_Store'] > + > +# The name of the Pygments (syntax highlighting) style to use. > +pygments_style = 'sphinx' > + > +# 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 = 'sphinx_rtd_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 = {} > + > +# 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'] > + > +# Custom sidebar templates, must be a dictionary that maps document names > +# to template names. > +# > +# This is required for the alabaster theme > +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars > +html_sidebars = { > + '**': [ > + 'relations.html', # needs 'show_related': True theme option to display > + 'searchbox.html', > + ] > +} > + > + > +# -- Options for HTMLHelp output ------------------------------------------ > + > +# Output file base name for HTML help builder. > +htmlhelp_basename = 'SoftPatchPaneldoc' > + > + > +# -- Options for LaTeX output --------------------------------------------- > + > +latex_elements = { > + # The paper size ('letterpaper' or 'a4paper'). > + # > + # 'papersize': 'letterpaper', > + > + # The font size ('10pt', '11pt' or '12pt'). > + # > + # 'pointsize': '10pt', > + > + # 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 = [ > + (master_doc, 'SoftPatchPanel.tex', u'Soft Patch Panel Documentation', > + u'Yasufumi Ogawa', 'manual'), > +] > + > + > +# -- Options for manual page output --------------------------------------- > + > +# One entry per manual page. List of tuples > +# (source start file, name, description, authors, manual section). > +man_pages = [ > + (master_doc, 'softpatchpanel', u'Soft Patch Panel Documentation', > + [author], 1) > +] > + > + > +# -- 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 = [ > + (master_doc, 'SoftPatchPanel', u'Soft Patch Panel Documentation', > + author, 'SoftPatchPanel', 'One line description of project.', > + 'Miscellaneous'), > +] > diff --git a/docs/guides/index.rst b/docs/guides/index.rst > new file mode 100644 > index 0000000..fcc03f3 > --- /dev/null > +++ b/docs/guides/index.rst > @@ -0,0 +1,40 @@ > +.. BSD LICENSE > + Copyright(c) 2010-2014 Intel Corporation. All rights reserved. > + All rights reserved. > + > + Redistribution and use in source and binary forms, with or without > + modification, are permitted provided that the following conditions > + are met: > + > + * Redistributions of source code must retain the above copyright > + notice, this list of conditions and the following disclaimer. > + * Redistributions in binary form must reproduce the above copyright > + notice, this list of conditions and the following disclaimer in > + the documentation and/or other materials provided with the > + distribution. > + * Neither the name of Intel Corporation nor the names of its > + contributors may be used to endorse or promote products derived > + from this software without specific prior written permission. > + > + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS > + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT > + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR > + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT > + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, > + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT > + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, > + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY > + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT > + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE > + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. > + > +SPP documentation > +================= > + > +.. toctree:: > + :maxdepth: 1 > + > + overview > + setup/index > + commands/index > + tools/index > diff --git a/docs/guides/setup/index.rst b/docs/guides/setup/index.rst > new file mode 100644 > index 0000000..1816462 > --- /dev/null > +++ b/docs/guides/setup/index.rst > @@ -0,0 +1,38 @@ > +.. BSD LICENSE > + Copyright(c) 2010-2014 Intel Corporation. All rights reserved. > + All rights reserved. > + > + Redistribution and use in source and binary forms, with or without > + modification, are permitted provided that the following conditions > + are met: > + > + * Redistributions of source code must retain the above copyright > + notice, this list of conditions and the following disclaimer. > + * Redistributions in binary form must reproduce the above copyright > + notice, this list of conditions and the following disclaimer in > + the documentation and/or other materials provided with the > + distribution. > + * Neither the name of Intel Corporation nor the names of its > + contributors may be used to endorse or promote products derived > + from this software without specific prior written permission. > + > + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS > + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT > + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR > + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT > + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, > + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT > + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, > + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY > + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT > + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE > + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. > + > +Setup Guide > +=========== > + > +.. toctree:: > + :maxdepth: 2 > + :numbered: > + > + setup_guide > diff --git a/docs/guides/setup/setup_guide.rst b/docs/guides/setup/setup_guide.rst > new file mode 100644 > index 0000000..77355d0 > --- /dev/null > +++ b/docs/guides/setup/setup_guide.rst > @@ -0,0 +1,38 @@ > +.. BSD LICENSE > + Copyright(c) 2010-2014 Intel Corporation. All rights reserved. > + All rights reserved. > + > + Redistribution and use in source and binary forms, with or without > + modification, are permitted provided that the following conditions > + are met: > + > + * Redistributions of source code must retain the above copyright > + notice, this list of conditions and the following disclaimer. > + * Redistributions in binary form must reproduce the above copyright > + notice, this list of conditions and the following disclaimer in > + the documentation and/or other materials provided with the > + distribution. > + * Neither the name of Intel Corporation nor the names of its > + contributors may be used to endorse or promote products derived > + from this software without specific prior written permission. > + > + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS > + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT > + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR > + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT > + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, > + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT > + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, > + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY > + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT > + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE > + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. > + > +Sample usage of the application > +=============================== > + > +Compilation > +----------- > + > +.. note:: > + This is a note. > -- Yasufumi Ogawa NTT Network Service Systems Labs