tosca2heat/tosca-parser/doc/source/index.rst

   1 .. tosca-parser documentation master file, created by
   2    sphinx-quickstart on Tue Jul  9 22:26:36 2013.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 Welcome to tosca-parser's documentation!
   7 ===========================================
   8
   9 The TOSCA Parser is developed to parse TOSCA Simple Profile in YAML. It reads
  10 the TOSCA templates and creates an in-memory graph of TOSCA nodes and their
  11 relationship.
  12
  13 The TOSCA Parser can also be used for parsing TOSCA Simple Profile for Network
  14 Functions Virtualization (NFV). The work to provide such a support was started
  15 with the release of TOSCA Parser 0.4.0 PyPI release and it is ongoing.
  16 The TOSCA Simple Profile for NFV can be accessed by using TOSCA version
  17 "tosca_simple_profile_for_nfv_1_0_0" in the template.
  18
  19 The TOSCA Parser now supports profile definition extensions that can be
  20 accessed via a custom tosca_definitions_version.  Extensions can be added by
  21 creating a module in the "toscaparser/extensions" directory.  See the "nfv"
  22 module for an example.
  23
  24 Contents:
  25
  26 .. toctree::
  27    :maxdepth: 2
  28
  29    installation
  30    usage
  31    contributing
  32
  33 Indices and tables
  34 ==================
  35
  36 * :ref:`genindex`
  37 * :ref:`modindex`
  38 * :ref:`search`