diff options
Diffstat (limited to 'tosca2heat/tosca-parser-0.3.0/doc/source')
5 files changed, 128 insertions, 0 deletions
diff --git a/tosca2heat/tosca-parser-0.3.0/doc/source/conf.py b/tosca2heat/tosca-parser-0.3.0/doc/source/conf.py new file mode 100755 index 0000000..e461246 --- /dev/null +++ b/tosca2heat/tosca-parser-0.3.0/doc/source/conf.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +# 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-0.3.0/doc/source/contributing.rst b/tosca2heat/tosca-parser-0.3.0/doc/source/contributing.rst new file mode 100644 index 0000000..8cb3146 --- /dev/null +++ b/tosca2heat/tosca-parser-0.3.0/doc/source/contributing.rst @@ -0,0 +1 @@ +.. include:: ../../CONTRIBUTING.rst
\ No newline at end of file diff --git a/tosca2heat/tosca-parser-0.3.0/doc/source/index.rst b/tosca2heat/tosca-parser-0.3.0/doc/source/index.rst new file mode 100644 index 0000000..31c22fe --- /dev/null +++ b/tosca2heat/tosca-parser-0.3.0/doc/source/index.rst @@ -0,0 +1,27 @@ +.. 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. + +Contents: + +.. toctree:: + :maxdepth: 2 + + installation + usage + contributing + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/tosca2heat/tosca-parser-0.3.0/doc/source/installation.rst b/tosca2heat/tosca-parser-0.3.0/doc/source/installation.rst new file mode 100644 index 0000000..f3805a5 --- /dev/null +++ b/tosca2heat/tosca-parser-0.3.0/doc/source/installation.rst @@ -0,0 +1,9 @@ +============ +Installation +============ + +You can clone the project and use it as below:: + + git clone https://github.com/openstack/tosca-parser + +Tosca-Parser can be installed via PyPI package as well. Refer to https://pypi.python.org/pypi/tosca-parser for available packages.
\ No newline at end of file diff --git a/tosca2heat/tosca-parser-0.3.0/doc/source/usage.rst b/tosca2heat/tosca-parser-0.3.0/doc/source/usage.rst new file mode 100644 index 0000000..2b822a8 --- /dev/null +++ b/tosca2heat/tosca-parser-0.3.0/doc/source/usage.rst @@ -0,0 +1,16 @@ +===== +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. |