summaryrefslogtreecommitdiffstats
path: root/tosca2heat/tosca-parser/doc/source/index.rst
diff options
context:
space:
mode:
authorshangxdy <shang.xiaodong@zte.com.cn>2016-04-07 14:08:49 -0400
committershangxdy <shang.xiaodong@zte.com.cn>2016-04-07 14:59:30 -0400
commitc8201c119ec686e79797721156767685fe848aca (patch)
treecce6aa15ded38d89c18a14b76c21f21e0b1a24f7 /tosca2heat/tosca-parser/doc/source/index.rst
parent4e4c86a06d58b1816c074c7f9da4c58bbf10368c (diff)
Update tosca lib to version 0.5
Use tosca-parser and heat-translator to analyze to the basic nfv-tosca type definitions, and use simple tosca new feature such as policy, group and trigger, which are now supported by the latest version of tosca-parser and heat-translator. JIRA:PARSER-18 Change-Id: I797bcacbb5b32005d0aeb0f3f32851ac96e30f01 Signed--off-by: shangxdy <shang.xiaodong@zte.com.cn> Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
Diffstat (limited to 'tosca2heat/tosca-parser/doc/source/index.rst')
-rw-r--r--tosca2heat/tosca-parser/doc/source/index.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/tosca2heat/tosca-parser/doc/source/index.rst b/tosca2heat/tosca-parser/doc/source/index.rst
new file mode 100644
index 0000000..c3894f4
--- /dev/null
+++ b/tosca2heat/tosca-parser/doc/source/index.rst
@@ -0,0 +1,38 @@
+.. 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`