summaryrefslogtreecommitdiffstats
path: root/tosca2heat/tosca-parser
diff options
context:
space:
mode:
authorzhipengh <huangzhipeng@huawei.com>2017-03-06 16:16:45 +0800
committerzhipengh <huangzhipeng@huawei.com>2017-03-07 19:42:30 +0800
commitc09ba66cc51c4db17503f79c05ea0b0cd0626596 (patch)
treed8bcb874d6c3c6b5f3962f24e775061134415486 /tosca2heat/tosca-parser
parent119d491d35d02195cd0f77ba63f9dc133c15666f (diff)
Danube Release Docs Fixup patch 2
This patch provide an initial content for the docs/ release/release-notes.rst file. Further work needed. Remove policy2tosca and yang2tosca doc files in the code folder, move tosca2heat diff files to release folder. Remove all the tosca2heat original upstream rst docs due to CI failures Change-Id: I789102a7974b5ac79445f90e08e3f8252e0f4169 Signed-off-by: zhipengh <huangzhipeng@huawei.com>
Diffstat (limited to 'tosca2heat/tosca-parser')
-rw-r--r--tosca2heat/tosca-parser/CONTRIBUTING.rst16
-rw-r--r--tosca2heat/tosca-parser/HACKING.rst4
-rw-r--r--tosca2heat/tosca-parser/README.rst54
-rw-r--r--tosca2heat/tosca-parser/doc/source/conf.py74
-rw-r--r--tosca2heat/tosca-parser/doc/source/contributing.rst1
-rw-r--r--tosca2heat/tosca-parser/doc/source/index.rst38
-rw-r--r--tosca2heat/tosca-parser/doc/source/installation.rst18
-rw-r--r--tosca2heat/tosca-parser/doc/source/usage.rst16
8 files changed, 0 insertions, 221 deletions
diff --git a/tosca2heat/tosca-parser/CONTRIBUTING.rst b/tosca2heat/tosca-parser/CONTRIBUTING.rst
deleted file mode 100644
index 7366825..0000000
--- a/tosca2heat/tosca-parser/CONTRIBUTING.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-If you would like to contribute to the development of OpenStack,
-you must follow the steps in this page:
-
- http://docs.openstack.org/infra/manual/developers.html
-
-Once those steps have been completed, changes to OpenStack
-should be submitted for review via the Gerrit tool, following
-the workflow documented at:
-
- http://docs.openstack.org/infra/manual/developers.html#development-workflow
-
-Pull requests submitted through GitHub will be ignored.
-
-Bugs should be filed on Launchpad, not GitHub:
-
- https://bugs.launchpad.net/tosca-parser \ No newline at end of file
diff --git a/tosca2heat/tosca-parser/HACKING.rst b/tosca2heat/tosca-parser/HACKING.rst
deleted file mode 100644
index 60505f1..0000000
--- a/tosca2heat/tosca-parser/HACKING.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-tosca-parser Style Commandments
-===============================================
-
-Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/ \ No newline at end of file
diff --git a/tosca2heat/tosca-parser/README.rst b/tosca2heat/tosca-parser/README.rst
deleted file mode 100644
index 0f94072..0000000
--- a/tosca2heat/tosca-parser/README.rst
+++ /dev/null
@@ -1,54 +0,0 @@
-========================
-Team and repository tags
-========================
-
-.. image:: http://governance.openstack.org/badges/tosca-parser.svg
- :target: http://governance.openstack.org/reference/tags/index.html
-
-.. Change things from this point on
-
-===============
-TOSCA Parser
-===============
-
-Overview
---------
-
-The TOSCA Parser is an OpenStack project and licensed under Apache 2. It is
-developed to parse TOSCA Simple Profile in YAML. It reads the TOSCA templates
-and creates an in-memory graph of TOSCA nodes and their relationship.
-
-Architecture
-------------
-
-The TOSCA Parser takes TOSCA YAML template or TOSCA Cloud Service Archive (CSAR)
-file as an input, with optional input of dictionary of needed parameters with their
-values, and produces in-memory objects of different TOSCA elements with their
-relationship to each other. It also creates a graph of TOSCA node templates and their
-relationship.
-
-The ToscaTemplate class located in the toscaparser/tosca_template.py is an entry
-class of the parser and various functionality of parser can be used by initiating
-this class. In order to see an example usage of TOSCA Parser from a separate tool,
-refer to the OpenStack heat-translator class TranslateTemplate located in the
-translator/osc/v1/translate.py module. The toscaparser/shell.py module of tosca-parser
-also provides a good reference on how to invoke TOSCA Parser from Command Line Interface.
-
-The toscaparser/elements sub-directory contains various modules to handle
-various TOSCA type elements like node type, relationship type etc. The
-entity_type.py module is a parent of all type elements. The toscaparser
-directory contains various python module to handle service template including
-topology template, node templates, relationship templates etc. The
-entity_template.py is a parent of all template elements.
-
-
-How To Use
-----------
-Please refer to `doc/source/usage.rst <https://github.com/openstack/tosca-parser/blob/master/doc/source/usage.rst>`_
-
-Project Info
-------------
-
-* License: Apache License, Version 2.0
-* Source: http://git.openstack.org/cgit/openstack/tosca-parser/
-
diff --git a/tosca2heat/tosca-parser/doc/source/conf.py b/tosca2heat/tosca-parser/doc/source/conf.py
deleted file mode 100644
index d5d9189..0000000
--- a/tosca2heat/tosca-parser/doc/source/conf.py
+++ /dev/null
@@ -1,74 +0,0 @@
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-# implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import os
-import sys
-
-sys.path.insert(0, os.path.abspath('../..'))
-# -- General configuration ----------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = [
- 'sphinx.ext.autodoc',
- #'sphinx.ext.intersphinx',
- 'oslosphinx'
-]
-
-# autodoc generation is a bit aggressive and a nuisance when doing heavy
-# text edit cycles.
-# execute "export SPHINX_DEBUG=1" in your terminal to disable
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'tosca-parser'
-copyright = u'2013, OpenStack Foundation'
-
-# 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
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# -- Options for HTML output --------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-# html_theme_path = ["."]
-# html_theme = 'default'
-# html_static_path = ['static']
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = '%sdoc' % project
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass
-# [howto/manual]).
-latex_documents = [
- ('index',
- '%s.tex' % project,
- u'%s Documentation' % project,
- u'OpenStack Foundation', 'manual'),
-]
-
-# Example configuration for intersphinx: refer to the Python standard library.
-#intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/tosca2heat/tosca-parser/doc/source/contributing.rst b/tosca2heat/tosca-parser/doc/source/contributing.rst
deleted file mode 100644
index 8cb3146..0000000
--- a/tosca2heat/tosca-parser/doc/source/contributing.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. include:: ../../CONTRIBUTING.rst \ No newline at end of file
diff --git a/tosca2heat/tosca-parser/doc/source/index.rst b/tosca2heat/tosca-parser/doc/source/index.rst
deleted file mode 100644
index c3894f4..0000000
--- a/tosca2heat/tosca-parser/doc/source/index.rst
+++ /dev/null
@@ -1,38 +0,0 @@
-.. tosca-parser documentation master file, created by
- sphinx-quickstart on Tue Jul 9 22:26:36 2013.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-Welcome to tosca-parser's documentation!
-===========================================
-
-The TOSCA Parser is developed to parse TOSCA Simple Profile in YAML. It reads
-the TOSCA templates and creates an in-memory graph of TOSCA nodes and their
-relationship.
-
-The TOSCA Parser can also be used for parsing TOSCA Simple Profile for Network
-Functions Virtualization (NFV). The work to provide such a support was started
-with the release of TOSCA Parser 0.4.0 PyPI release and it is ongoing.
-The TOSCA Simple Profile for NFV can be accessed by using TOSCA version
-"tosca_simple_profile_for_nfv_1_0_0" in the template.
-
-The TOSCA Parser now supports profile definition extensions that can be
-accessed via a custom tosca_definitions_version. Extensions can be added by
-creating a module in the "toscaparser/extensions" directory. See the "nfv"
-module for an example.
-
-Contents:
-
-.. toctree::
- :maxdepth: 2
-
- installation
- usage
- contributing
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/tosca2heat/tosca-parser/doc/source/installation.rst b/tosca2heat/tosca-parser/doc/source/installation.rst
deleted file mode 100644
index 5476d41..0000000
--- a/tosca2heat/tosca-parser/doc/source/installation.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-============
-Installation
-============
-
-PyPI Installation
------------------
-Tosca-Parser can be installed via a PyPI package. Refer to https://pypi.python.org/pypi/tosca-parser for available packages.
-The latest release can be simply installed by running the following command::
-
- sudo pip install tosca-parser
-
-Manual Installation
--------------------
-You can manually install the latest code available at the TOSCA-Parser github repository by following these steps::
-
- git clone https://github.com/openstack/tosca-parser
- cd tosca-parser
- sudo python setup.py install
diff --git a/tosca2heat/tosca-parser/doc/source/usage.rst b/tosca2heat/tosca-parser/doc/source/usage.rst
deleted file mode 100644
index 2b822a8..0000000
--- a/tosca2heat/tosca-parser/doc/source/usage.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-=====
-Usage
-=====
-
-The TOSCA Parser can be used as a library by any client program, for example,
-OpenStack heat-translator uses it to translate TOSCA to Heat Orchestration
-Template (HOT).
-
-For an easy reference on how TOSCA Parser can be used programmatically or to
-test that the a TOSCA template passes validation, refer to the tosca_parser.py
-test program which is located at the root level of the project. Alternatively,
-you can install 0.3.0 or higher PyPI release of TOSCA-Parser as available at the
-https://pypi.python.org/pypi/tosca-parser and test use the parser via CLI
-entry point as::
- tosca-parser --template-file=toscaparser/tests/data/tosca_helloworld.yaml
-The value to the --template-file is required to be a relative or an absolute path.