You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ariatosca.apache.org by em...@apache.org on 2017/07/03 19:56:39 UTC
[22/31] incubator-ariatosca git commit: ARIA-286 Sphinx documentation
for code and CLI
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.modeling.models.rst
----------------------------------------------------------------------
diff --git a/docs/aria.modeling.models.rst b/docs/aria.modeling.models.rst
new file mode 100644
index 0000000..6431780
--- /dev/null
+++ b/docs/aria.modeling.models.rst
@@ -0,0 +1,21 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+:mod:`aria.modeling.models`
+===========================
+
+.. automodule:: aria.modeling.models
+ :no-show-inheritance:
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.modeling.rst
----------------------------------------------------------------------
diff --git a/docs/aria.modeling.rst b/docs/aria.modeling.rst
new file mode 100644
index 0000000..b85e22c
--- /dev/null
+++ b/docs/aria.modeling.rst
@@ -0,0 +1,56 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.modeling`
+====================
+
+.. automodule:: aria.modeling
+
+:mod:`aria.modeling.constraints`
+--------------------------------
+
+.. automodule:: aria.modeling.constraints
+
+:mod:`aria.modeling.exceptions`
+-------------------------------
+
+.. automodule:: aria.modeling.exceptions
+
+:mod:`aria.modeling.functions`
+------------------------------
+
+.. automodule:: aria.modeling.functions
+
+:mod:`aria.modeling.mixins`
+---------------------------
+
+.. automodule:: aria.modeling.mixins
+
+:mod:`aria.modeling.relationship`
+---------------------------------
+
+.. automodule:: aria.modeling.relationship
+
+:mod:`aria.modeling.types`
+--------------------------
+
+.. automodule:: aria.modeling.types
+
+:mod:`aria.modeling.utils`
+--------------------------
+
+.. automodule:: aria.modeling.utils
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.orchestrator.context.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.context.rst b/docs/aria.orchestrator.context.rst
new file mode 100644
index 0000000..395befc
--- /dev/null
+++ b/docs/aria.orchestrator.context.rst
@@ -0,0 +1,46 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator.context`
+================================
+
+.. automodule:: aria.orchestrator.context
+
+:mod:`aria.orchestrator.context.common`
+---------------------------------------
+
+.. automodule:: aria.orchestrator.context.common
+
+:mod:`aria.orchestrator.context.exceptions`
+-------------------------------------------
+
+.. automodule:: aria.orchestrator.context.exceptions
+
+:mod:`aria.orchestrator.context.operation`
+------------------------------------------
+
+.. automodule:: aria.orchestrator.context.operation
+
+:mod:`aria.orchestrator.context.toolbelt`
+-----------------------------------------
+
+.. automodule:: aria.orchestrator.context.toolbelt
+
+:mod:`aria.orchestrator.context.workflow`
+-----------------------------------------
+
+.. automodule:: aria.orchestrator.context.workflow
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.orchestrator.execution_plugin.ctx_proxy.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.execution_plugin.ctx_proxy.rst b/docs/aria.orchestrator.execution_plugin.ctx_proxy.rst
new file mode 100644
index 0000000..47ed598
--- /dev/null
+++ b/docs/aria.orchestrator.execution_plugin.ctx_proxy.rst
@@ -0,0 +1,31 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator.execution_plugin.ctx_proxy`
+===================================================
+
+.. automodule:: aria.orchestrator.execution_plugin.ctx_proxy
+
+:mod:`aria.orchestrator.execution_plugin.ctx_proxy.client`
+----------------------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.ctx_proxy.client
+
+:mod:`aria.orchestrator.execution_plugin.ctx_proxy.server`
+----------------------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.ctx_proxy.server
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.orchestrator.execution_plugin.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.execution_plugin.rst b/docs/aria.orchestrator.execution_plugin.rst
new file mode 100644
index 0000000..177a316
--- /dev/null
+++ b/docs/aria.orchestrator.execution_plugin.rst
@@ -0,0 +1,56 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator.execution_plugin`
+=========================================
+
+.. automodule:: aria.orchestrator.execution_plugin
+
+:mod:`aria.orchestrator.execution_plugin.common`
+------------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.common
+
+:mod:`aria.orchestrator.execution_plugin.constants`
+---------------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.constants
+
+:mod:`aria.orchestrator.execution_plugin.environment_globals`
+-------------------------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.environment_globals
+
+:mod:`aria.orchestrator.execution_plugin.exceptions`
+----------------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.exceptions
+
+:mod:`aria.orchestrator.execution_plugin.instantiation`
+-------------------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.instantiation
+
+:mod:`aria.orchestrator.execution_plugin.local`
+-----------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.local
+
+:mod:`aria.orchestrator.execution_plugin.operations`
+----------------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.operations
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.orchestrator.execution_plugin.ssh.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.execution_plugin.ssh.rst b/docs/aria.orchestrator.execution_plugin.ssh.rst
new file mode 100644
index 0000000..8bbaa57
--- /dev/null
+++ b/docs/aria.orchestrator.execution_plugin.ssh.rst
@@ -0,0 +1,31 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator.execution_plugin.ssh`
+=============================================
+
+.. automodule:: aria.orchestrator.execution_plugin.ssh
+
+:mod:`aria.orchestrator.execution_plugin.ssh.operations`
+--------------------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.ssh.operations
+
+:mod:`aria.orchestrator.execution_plugin.ssh.tunnel`
+----------------------------------------------------
+
+.. automodule:: aria.orchestrator.execution_plugin.ssh.tunnel
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.orchestrator.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.rst b/docs/aria.orchestrator.rst
new file mode 100644
index 0000000..33454e6
--- /dev/null
+++ b/docs/aria.orchestrator.rst
@@ -0,0 +1,46 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator`
+========================
+
+.. automodule:: aria.orchestrator
+
+:mod:`aria.orchestrator.decorators`
+-----------------------------------
+
+.. automodule:: aria.orchestrator.decorators
+
+:mod:`aria.orchestrator.events`
+-------------------------------
+
+.. automodule:: aria.orchestrator.events
+
+:mod:`aria.orchestrator.exceptions`
+-----------------------------------
+
+.. automodule:: aria.orchestrator.exceptions
+
+:mod:`aria.orchestrator.plugin`
+-------------------------------
+
+.. automodule:: aria.orchestrator.plugin
+
+:mod:`aria.orchestrator.workflow_runner`
+----------------------------------------
+
+.. automodule:: aria.orchestrator.workflow_runner
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.orchestrator.workflows.api.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.workflows.api.rst b/docs/aria.orchestrator.workflows.api.rst
new file mode 100644
index 0000000..7ecac75
--- /dev/null
+++ b/docs/aria.orchestrator.workflows.api.rst
@@ -0,0 +1,31 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator.workflows.api`
+======================================
+
+.. automodule:: aria.orchestrator.workflows.api
+
+:mod:`aria.orchestrator.workflows.api.task_graph`
+-------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.api.task_graph
+
+:mod:`aria.orchestrator.workflows.api.task`
+-------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.api.task
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.orchestrator.workflows.builtin.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.workflows.builtin.rst b/docs/aria.orchestrator.workflows.builtin.rst
new file mode 100644
index 0000000..de1a8f9
--- /dev/null
+++ b/docs/aria.orchestrator.workflows.builtin.rst
@@ -0,0 +1,57 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+
+:mod:`aria.orchestrator.workflows.builtin`
+==========================================
+
+.. automodule:: aria.orchestrator.workflows.builtin
+
+:mod:`aria.orchestrator.workflows.builtin.execute_operation`
+------------------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.builtin.execute_operation
+
+:mod:`aria.orchestrator.workflows.builtin.heal`
+-----------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.builtin.heal
+
+:mod:`aria.orchestrator.workflows.builtin.install`
+--------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.builtin.install
+
+:mod:`aria.orchestrator.workflows.builtin.start`
+------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.builtin.start
+
+:mod:`aria.orchestrator.workflows.builtin.stop`
+-----------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.builtin.stop
+
+:mod:`aria.orchestrator.workflows.builtin.uninstall`
+----------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.builtin.uninstall
+
+:mod:`aria.orchestrator.workflows.builtin.workflows`
+----------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.builtin.workflows
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.orchestrator.workflows.executor.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.workflows.executor.rst b/docs/aria.orchestrator.workflows.executor.rst
new file mode 100644
index 0000000..cde0a77
--- /dev/null
+++ b/docs/aria.orchestrator.workflows.executor.rst
@@ -0,0 +1,46 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator.workflows.executor`
+===========================================
+
+.. automodule:: aria.orchestrator.workflows.executor
+
+:mod:`aria.orchestrator.workflows.executor.base`
+------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.executor.base
+
+:mod:`aria.orchestrator.workflows.executor.celery`
+--------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.executor.celery
+
+:mod:`aria.orchestrator.workflows.executor.dry`
+-----------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.executor.dry
+
+:mod:`aria.orchestrator.workflows.executor.process`
+---------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.executor.process
+
+:mod:`aria.orchestrator.workflows.executor.thread`
+--------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.executor.thread
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.orchestrator.workflows.rst
----------------------------------------------------------------------
diff --git a/docs/aria.orchestrator.workflows.rst b/docs/aria.orchestrator.workflows.rst
new file mode 100644
index 0000000..c0bc1c1
--- /dev/null
+++ b/docs/aria.orchestrator.workflows.rst
@@ -0,0 +1,51 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.orchestrator.workflows`
+==================================
+
+.. automodule:: aria.orchestrator.workflows
+
+:mod:`aria.orchestrator.workflows.events_logging`
+-------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.events_logging
+
+:mod:`aria.orchestrator.workflows.exceptions`
+---------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.exceptions
+
+:mod:`aria.orchestrator.workflows.core`
+---------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.core
+
+:mod:`aria.orchestrator.workflows.core.graph_compiler`
+------------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.core.graph_compiler
+
+:mod:`aria.orchestrator.workflows.core.engine`
+----------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.core.engine
+
+:mod:`aria.orchestrator.workflows.core.events_handler`
+------------------------------------------------------
+
+.. automodule:: aria.orchestrator.workflows.core.events_handler
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.parser.consumption.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.consumption.rst b/docs/aria.parser.consumption.rst
new file mode 100644
index 0000000..3d9fc6e
--- /dev/null
+++ b/docs/aria.parser.consumption.rst
@@ -0,0 +1,21 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.consumption`
+==============================
+
+.. automodule:: aria.parser.consumption
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.parser.loading.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.loading.rst b/docs/aria.parser.loading.rst
new file mode 100644
index 0000000..0ae7565
--- /dev/null
+++ b/docs/aria.parser.loading.rst
@@ -0,0 +1,21 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.loading`
+==========================
+
+.. automodule:: aria.parser.loading
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.parser.modeling.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.modeling.rst b/docs/aria.parser.modeling.rst
new file mode 100644
index 0000000..16c359c
--- /dev/null
+++ b/docs/aria.parser.modeling.rst
@@ -0,0 +1,21 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.modeling`
+===========================
+
+.. automodule:: aria.parser.modeling
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.parser.presentation.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.presentation.rst b/docs/aria.parser.presentation.rst
new file mode 100644
index 0000000..6c63b2e
--- /dev/null
+++ b/docs/aria.parser.presentation.rst
@@ -0,0 +1,21 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.presentation`
+===============================
+
+.. automodule:: aria.parser.presentation
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.parser.reading.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.reading.rst b/docs/aria.parser.reading.rst
new file mode 100644
index 0000000..b1d4f6c
--- /dev/null
+++ b/docs/aria.parser.reading.rst
@@ -0,0 +1,21 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.reading`
+==========================
+
+.. automodule:: aria.parser.reading
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.parser.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.rst b/docs/aria.parser.rst
new file mode 100644
index 0000000..700f03d
--- /dev/null
+++ b/docs/aria.parser.rst
@@ -0,0 +1,31 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser`
+==================
+
+.. automodule:: aria.parser
+
+:mod:`aria.parser.exceptions`
+-----------------------------
+
+.. automodule:: aria.parser.exceptions
+
+:mod:`aria.parser.specification`
+--------------------------------
+
+.. automodule:: aria.parser.specification
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.parser.validation.rst
----------------------------------------------------------------------
diff --git a/docs/aria.parser.validation.rst b/docs/aria.parser.validation.rst
new file mode 100644
index 0000000..621898b
--- /dev/null
+++ b/docs/aria.parser.validation.rst
@@ -0,0 +1,21 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.parser.validation`
+=============================
+
+.. automodule:: aria.parser.validation
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.rst
----------------------------------------------------------------------
diff --git a/docs/aria.rst b/docs/aria.rst
new file mode 100644
index 0000000..1a0dae5
--- /dev/null
+++ b/docs/aria.rst
@@ -0,0 +1,40 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+:mod:`aria`
+===========
+
+.. automodule:: aria
+
+:mod:`aria.core`
+----------------
+
+.. automodule:: aria.core
+
+:mod:`aria.exceptions`
+----------------------
+
+.. automodule:: aria.exceptions
+
+:mod:`aria.extension`
+---------------------
+
+.. automodule:: aria.extension
+
+:mod:`aria.logger`
+------------------
+
+.. automodule:: aria.logger
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.storage.rst
----------------------------------------------------------------------
diff --git a/docs/aria.storage.rst b/docs/aria.storage.rst
new file mode 100644
index 0000000..7c51c2f
--- /dev/null
+++ b/docs/aria.storage.rst
@@ -0,0 +1,51 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.storage`
+===================
+
+.. automodule:: aria.storage
+
+:mod:`aria.storage.api`
+-----------------------
+
+.. automodule:: aria.storage.api
+
+:mod:`aria.storage.collection_instrumentation`
+----------------------------------------------
+
+.. automodule:: aria.storage.collection_instrumentation
+
+:mod:`aria.storage.core`
+------------------------
+
+.. automodule:: aria.storage.core
+
+:mod:`aria.storage.exceptions`
+------------------------------
+
+.. automodule:: aria.storage.exceptions
+
+:mod:`aria.storage.filesystem_rapi`
+-----------------------------------
+
+.. automodule:: aria.storage.filesystem_rapi
+
+:mod:`aria.storage.sql_mapi`
+----------------------------
+
+.. automodule:: aria.storage.sql_mapi
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria.utils.rst
----------------------------------------------------------------------
diff --git a/docs/aria.utils.rst b/docs/aria.utils.rst
new file mode 100644
index 0000000..220c0cd
--- /dev/null
+++ b/docs/aria.utils.rst
@@ -0,0 +1,121 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+
+:mod:`aria.utils`
+=================
+
+.. automodule:: aria.utils
+
+:mod:`aria.utils.archive`
+-------------------------
+
+.. automodule:: aria.utils.archive
+
+:mod:`aria.utils.argparse`
+--------------------------
+
+.. automodule:: aria.utils.argparse
+
+:mod:`aria.utils.caching`
+-------------------------
+
+.. automodule:: aria.utils.caching
+
+:mod:`aria.utils.collections`
+-----------------------------
+
+.. automodule:: aria.utils.collections
+
+:mod:`aria.utils.console`
+-------------------------
+
+.. automodule:: aria.utils.console
+
+:mod:`aria.utils.exceptions`
+----------------------------
+
+.. automodule:: aria.utils.exceptions
+
+:mod:`aria.utils.file`
+----------------------
+
+.. automodule:: aria.utils.file
+
+:mod:`aria.utils.formatting`
+----------------------------
+
+.. automodule:: aria.utils.formatting
+
+:mod:`aria.utils.http`
+----------------------
+
+.. automodule:: aria.utils.http
+
+:mod:`aria.utils.imports`
+-------------------------
+
+.. automodule:: aria.utils.imports
+
+:mod:`aria.utils.openclose`
+---------------------------
+
+.. automodule:: aria.utils.openclose
+
+:mod:`aria.utils.plugin`
+------------------------
+
+.. automodule:: aria.utils.plugin
+
+:mod:`aria.utils.process`
+-------------------------
+
+.. automodule:: aria.utils.process
+
+:mod:`aria.utils.specification`
+-------------------------------
+
+.. automodule:: aria.utils.specification
+
+:mod:`aria.utils.threading`
+---------------------------
+
+.. automodule:: aria.utils.threading
+
+:mod:`aria.utils.type`
+----------------------
+
+.. automodule:: aria.utils.type
+
+:mod:`aria.utils.uris`
+----------------------
+
+.. automodule:: aria.utils.uris
+
+:mod:`aria.utils.uuid`
+----------------------
+
+.. automodule:: aria.utils.uuid
+
+:mod:`aria.utils.validation`
+----------------------------
+
+.. automodule:: aria.utils.validation
+
+:mod:`aria.utils.versions`
+--------------------------
+
+.. automodule:: aria.utils.versions
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria_extension_tosca.simple_nfv_v1_0.rst
----------------------------------------------------------------------
diff --git a/docs/aria_extension_tosca.simple_nfv_v1_0.rst b/docs/aria_extension_tosca.simple_nfv_v1_0.rst
new file mode 100644
index 0000000..6e7b6cd
--- /dev/null
+++ b/docs/aria_extension_tosca.simple_nfv_v1_0.rst
@@ -0,0 +1,20 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+:mod:`aria_extension_tosca.simple_nfv_v1_0`
+===========================================
+
+.. automodule:: aria_extension_tosca.simple_nfv_v1_0
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria_extension_tosca.simple_v1_0.modeling.rst
----------------------------------------------------------------------
diff --git a/docs/aria_extension_tosca.simple_v1_0.modeling.rst b/docs/aria_extension_tosca.simple_v1_0.modeling.rst
new file mode 100644
index 0000000..8bc5499
--- /dev/null
+++ b/docs/aria_extension_tosca.simple_v1_0.modeling.rst
@@ -0,0 +1,75 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling`
+================================================
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.artifacts`
+----------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.artifacts
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.capabilities`
+-------------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.capabilities
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.constraints`
+------------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.constraints
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.copy`
+-----------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.copy
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.data_types`
+-----------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.data_types
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.functions`
+----------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.functions
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.interfaces`
+-----------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.interfaces
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.parameters`
+-----------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.parameters
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.policies`
+---------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.policies
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.requirements`
+-------------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.requirements
+
+:mod:`aria_extension_tosca.simple_v1_0.modeling.substitution_mappings`
+----------------------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.modeling.substitution_mappings
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria_extension_tosca.simple_v1_0.presentation.rst
----------------------------------------------------------------------
diff --git a/docs/aria_extension_tosca.simple_v1_0.presentation.rst b/docs/aria_extension_tosca.simple_v1_0.presentation.rst
new file mode 100644
index 0000000..964c029
--- /dev/null
+++ b/docs/aria_extension_tosca.simple_v1_0.presentation.rst
@@ -0,0 +1,40 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+:mod:`aria_extension_tosca.simple_v1_0.presentation`
+====================================================
+
+.. automodule:: aria_extension_tosca.simple_v1_0.presentation
+
+:mod:`aria_extension_tosca.simple_v1_0.presentation.extensible`
+---------------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.presentation.extensible
+
+:mod:`aria_extension_tosca.simple_v1_0.presentation.field_getters`
+------------------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.presentation.field_getters
+
+:mod:`aria_extension_tosca.simple_v1_0.presentation.field_validators`
+---------------------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.presentation.field_validators
+
+:mod:`aria_extension_tosca.simple_v1_0.presentation.types`
+----------------------------------------------------------
+
+.. automodule:: aria_extension_tosca.simple_v1_0.presentation.types
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/aria_extension_tosca.simple_v1_0.rst
----------------------------------------------------------------------
diff --git a/docs/aria_extension_tosca.simple_v1_0.rst b/docs/aria_extension_tosca.simple_v1_0.rst
new file mode 100644
index 0000000..bdae6ab
--- /dev/null
+++ b/docs/aria_extension_tosca.simple_v1_0.rst
@@ -0,0 +1,20 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+:mod:`aria_extension_tosca.simple_v1_0`
+=======================================
+
+.. automodule:: aria_extension_tosca.simple_v1_0
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/cli.rst
----------------------------------------------------------------------
diff --git a/docs/cli.rst b/docs/cli.rst
new file mode 100644
index 0000000..ee51545
--- /dev/null
+++ b/docs/cli.rst
@@ -0,0 +1,57 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+CLI
+===
+
+.. click:: aria.cli.main:_aria
+ :prog: aria
+
+.. click:: aria.cli.commands.reset:reset
+ :prog: aria reset
+ :show-nested:
+
+.. click:: aria.cli.commands.plugins:plugins
+ :prog: aria plugins
+ :show-nested:
+
+.. click:: aria.cli.commands.service_templates:service_templates
+ :prog: aria service_templates
+ :show-nested:
+
+.. click:: aria.cli.commands.node_templates:node_templates
+ :prog: aria node_templates
+ :show-nested:
+
+.. click:: aria.cli.commands.services:services
+ :prog: aria services
+ :show-nested:
+
+.. click:: aria.cli.commands.nodes:nodes
+ :prog: aria nodes
+ :show-nested:
+
+.. click:: aria.cli.commands.workflows:workflows
+ :prog: aria workflows
+ :show-nested:
+
+.. click:: aria.cli.commands.executions:executions
+ :prog: aria executions
+ :show-nested:
+
+.. click:: aria.cli.commands.logs:logs
+ :prog: aria logs
+ :show-nested:
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/conf.py
----------------------------------------------------------------------
diff --git a/docs/conf.py b/docs/conf.py
index e557f02..6361621 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,7 +15,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-# ARIA documentation build configuration file.
+# ARIA TOSCA documentation build configuration file.
#
# This file is execfile()d with the current directory set to its
# containing dir.
@@ -48,7 +48,12 @@ with open('../VERSION') as f:
# 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']
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.autosummary',
+ 'sphinx.ext.intersphinx',
+ 'sphinx_click.ext'
+]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -67,9 +72,9 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = u'ARIA'
-copyright = u'2016, Apache Software Foundation' # @ReservedAssignment
-author = u'ARIA'
+project = u'ARIA TOSCA'
+copyright = u'2016-2017, Apache Software Foundation' # @ReservedAssignment
+author = u'Apache Software Foundation'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -152,7 +157,7 @@ html_theme = 'sphinx_rtd_theme'
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
-# html_title = u'ARIA v0.1.0'
+# html_title = u'ARIA TOSCA v0.1.0'
# A shorter title for the navigation bar. Default is the same as html_title.
#
@@ -252,7 +257,7 @@ html_static_path = ['_static']
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
-htmlhelp_basename = 'ARIAdoc'
+htmlhelp_basename = 'ARIATOSCAdoc'
# -- Options for LaTeX output ---------------------------------------------
@@ -278,7 +283,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, 'ARIA.tex', u'ARIA',
+ (master_doc, 'ARIATOSCA.tex', u'ARIA TOSCA',
u'Apache Software Foundation', 'manual'),
]
@@ -314,7 +319,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- (master_doc, 'aria', u'ARIA',
+ (master_doc, 'aria', u'ARIA TOSCA',
[author], 1)
]
@@ -329,8 +334,9 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- (master_doc, 'ARIA', u'ARIA',
- author, 'ARIA', 'Toolkit for parsing TOSCA.',
+ (master_doc, 'ARIATOSCA', u'ARIA TOSCA',
+ author, 'ARIA TOSCA', 'an open, light, CLI-driven library of orchestration tools that other '
+ 'open projects can consume to easily build TOSCA-based orchestration solutions.',
'Miscellaneous'),
]
@@ -350,19 +356,61 @@ texinfo_documents = [
#
# texinfo_no_detailmenu = False
+
+# -- Options for InterSphinx
+
+intersphinx_mapping = {
+ 'python': ('https://docs.python.org/2.7', None)
+}
+
# -- Options for Python domain
-# Include __init__ docstring into class docstring
+# Append __init__ docstring into class docstring
autoclass_content = 'both'
# Default to everything important
-autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']
+autodoc_default_flags = [
+ 'members',
+ 'undoc-members',
+ 'show-inheritance'
+]
-def on_skip_members(app, what, name, obj, skip, options):
- if not skip:
- if name in ('FIELDS', 'ALLOW_UNKNOWN_FIELDS', 'SHORT_FORM_FIELD'):
- skip = True
+SKIP_MEMBERS = (
+ 'FIELDS',
+ 'ALLOW_UNKNOWN_FIELDS',
+ 'SHORT_FORM_FIELD',
+ 'INSTRUMENTATION_FIELDS'
+)
+
+SKIP_MEMBER_SUFFIXES = (
+ '_fk',
+)
+
+NEVER_SKIP_MEMBERS = (
+ '__evaluate__',
+)
+
+# 'autodoc-skip-member' event
+def on_skip_member(app, what, name, obj, skip, options):
+ if name in NEVER_SKIP_MEMBERS:
+ return False
+ if name in SKIP_MEMBERS:
+ return True
+ for suffix in SKIP_MEMBER_SUFFIXES:
+ if name.endswith(suffix):
+ return True
return skip
-
+
+from sphinx.domains.python import PythonDomain
+
+class PatchedPythonDomain(PythonDomain):
+ # See: https://github.com/sphinx-doc/sphinx/issues/3866
+ def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
+ if 'refspecific' in node:
+ del node['refspecific']
+ return super(PatchedPythonDomain, self).resolve_xref(
+ env, fromdocname, builder, typ, target, node, contnode)
+
def setup(app):
- app.connect('autodoc-skip-member', on_skip_members)
+ app.connect('autodoc-skip-member', on_skip_member)
+ app.override_domain(PatchedPythonDomain)
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/index.rst
----------------------------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index d915ae6..f68769b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,24 +14,68 @@
See the License for the specific language governing permissions and
limitations under the License.
+User Manual for ARIA TOSCA
+==========================
-ARIA API
-========
+`ARIA TOSCA <http://ariatosca.incubator.apache.org/>`__ is an open, light, CLI-driven library of
+orchestration tools that other open projects can consume to easily build
+`TOSCA <https://www.oasis-open.org/committees/tosca/>`__-based orchestration solutions. ARIA is now
+an incubation project at the Apache Software Foundation.
-`ARIA (Agile Reference Implementation of Automation) <http://ariatosca.org/>`__ is a an open,
-light, CLI-driven library of orchestration tools that other open projects can consume to easily
-build `TOSCA <https://www.oasis-open.org/committees/tosca/>`__-based orchestration solutions. It
-supports NFV and hybrid cloud scenarios.
+Interfaces
+----------
+.. toctree::
+ :maxdepth: 1
+ :includehidden:
+
+ cli
+ rest
+
+SDK
+---
+
+Core
+####
+
+.. toctree::
+ :maxdepth: 1
+ :includehidden:
+
+ aria
+ aria.cli
+ aria.modeling
+ aria.modeling.models
+ aria.orchestrator
+ aria.orchestrator.context
+ aria.orchestrator.execution_plugin
+ aria.orchestrator.execution_plugin.ctx_proxy
+ aria.orchestrator.execution_plugin.ssh
+ aria.orchestrator.workflows
+ aria.orchestrator.workflows.api
+ aria.orchestrator.workflows.builtin
+ aria.orchestrator.workflows.executor
+ aria.parser
+ aria.parser.consumption
+ aria.parser.loading
+ aria.parser.modeling
+ aria.parser.presentation
+ aria.parser.reading
+ aria.parser.validation
+ aria.storage
+ aria.utils
-Packages
---------
+Extensions
+##########
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
+ :includehidden:
- parser
- tosca
+ aria_extension_tosca.simple_v1_0
+ aria_extension_tosca.simple_v1_0.modeling
+ aria_extension_tosca.simple_v1_0.presentation
+ aria_extension_tosca.simple_nfv_v1_0
Indices and Tables
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/parser.rst
----------------------------------------------------------------------
diff --git a/docs/parser.rst b/docs/parser.rst
deleted file mode 100644
index 5db02e2..0000000
--- a/docs/parser.rst
+++ /dev/null
@@ -1,56 +0,0 @@
-..
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You 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.
-
-
-`aria.parser` Package
-#####################
-
-This is the core parser API.
-
-:mod:`aria.parser`
-******************
-
-.. automodule:: aria
-
-:mod:`aria.parser.consumption`
-******************************
-
-.. automodule:: aria.parser.consumption
-
-:mod:`aria.parser.modeling`
-***************************
-
-.. automodule:: aria.parser.modeling
-
-:mod:`aria.parser.loading`
-**************************
-
-.. automodule:: aria.parser.loading
-
-:mod:`aria.parser.presentation`
-*******************************
-
-.. automodule:: aria.parser.presentation
-
-:mod:`aria.parser.reading`
-**************************
-
-.. automodule:: aria.parser.reading
-
-:mod:`aria.parser.validation`
-*****************************
-
-.. automodule:: aria.parser.validation
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/requirements.txt
----------------------------------------------------------------------
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 976c5b6..a49bb26 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -11,4 +11,5 @@
# limitations under the License.
Sphinx>=1.6.2, <2.0.0
-sphinx_rtd_theme>=0.2.4, <1.0.0
+sphinx_rtd_theme>=0.2.4, <2.0.0
+sphinx-click>=1.0.2, <1.1.0
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/rest.rst
----------------------------------------------------------------------
diff --git a/docs/rest.rst b/docs/rest.rst
new file mode 100644
index 0000000..185837e
--- /dev/null
+++ b/docs/rest.rst
@@ -0,0 +1,20 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+
+REST
+====
+
+TODO
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/docs/tosca.rst
----------------------------------------------------------------------
diff --git a/docs/tosca.rst b/docs/tosca.rst
deleted file mode 100644
index c98a4a9..0000000
--- a/docs/tosca.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-..
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You 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.
-
-
-`aria_extension_tosca` Package
-##############################
-
-This is the ARIA TOSCA extension.
-
-:mod:`aria_extension_tosca`
-***************************
-
-.. automodule:: aria_extension_tosca
-
-:mod:`aria_extension_tosca.simple_v1_0`
-***************************************
-
-.. automodule:: aria_extension_tosca.simple_v1_0
-
-:mod:`aria_extension_tosca.simple_nfv_v1_0`
-*******************************************
-
-.. automodule:: aria_extension_tosca.simple_nfv_v1_0
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py
----------------------------------------------------------------------
diff --git a/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py b/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py
index cd07f42..64178aa 100644
--- a/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py
+++ b/extensions/aria_extension_tosca/simple_nfv_v1_0/presenter.py
@@ -21,12 +21,12 @@ from ..simple_v1_0 import ToscaSimplePresenter1_0
class ToscaSimpleNfvPresenter1_0(ToscaSimplePresenter1_0): # pylint: disable=invalid-name,abstract-method
"""
- ARIA presenter for the `TOSCA Simple Profile for NFV v1.0 csd03 <http://docs.oasis-open.org
- /tosca/tosca-nfv/v1.0/csd03/tosca-nfv-v1.0-csd03.html>`__.
+ ARIA presenter for the `TOSCA Simple Profile for NFV v1.0 csd04 <http://docs.oasis-open.org
+ /tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html>`__.
- Supported :code:`tosca_definitions_version` values:
+ Supported ``tosca_definitions_version`` values:
- * :code:`tosca_simple_profile_for_nfv_1_0`
+ * ``tosca_simple_profile_for_nfv_1_0``
"""
DSL_VERSIONS = ('tosca_simple_profile_for_nfv_1_0',)
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/extensions/aria_extension_tosca/simple_v1_0/__init__.py
----------------------------------------------------------------------
diff --git a/extensions/aria_extension_tosca/simple_v1_0/__init__.py b/extensions/aria_extension_tosca/simple_v1_0/__init__.py
index 7dcc60a..61995db 100644
--- a/extensions/aria_extension_tosca/simple_v1_0/__init__.py
+++ b/extensions/aria_extension_tosca/simple_v1_0/__init__.py
@@ -13,6 +13,115 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+"""
+Parser implementation of `TOSCA Simple Profile v1.0 cos01 <http://docs.oasis-open.org/tosca
+/TOSCA-Simple-Profile-YAML/v1.0/cos01/TOSCA-Simple-Profile-YAML-v1.0-cos01.html>`__.
+
+.. autosummary::
+ :nosignatures:
+
+ aria_extension_tosca.simple_v1_0.ToscaSimplePresenter1_0
+
+Assignments
+-----------
+
+.. autosummary::
+ :nosignatures:
+
+ aria_extension_tosca.simple_v1_0.PropertyAssignment
+ aria_extension_tosca.simple_v1_0.OperationAssignment
+ aria_extension_tosca.simple_v1_0.InterfaceAssignment
+ aria_extension_tosca.simple_v1_0.RelationshipAssignment
+ aria_extension_tosca.simple_v1_0.RequirementAssignment
+ aria_extension_tosca.simple_v1_0.AttributeAssignment
+ aria_extension_tosca.simple_v1_0.CapabilityAssignment
+ aria_extension_tosca.simple_v1_0.ArtifactAssignment
+
+Definitions
+-----------
+
+.. autosummary::
+ :nosignatures:
+
+ aria_extension_tosca.simple_v1_0.PropertyDefinition
+ aria_extension_tosca.simple_v1_0.AttributeDefinition
+ aria_extension_tosca.simple_v1_0.ParameterDefinition
+ aria_extension_tosca.simple_v1_0.OperationDefinition
+ aria_extension_tosca.simple_v1_0.InterfaceDefinition
+ aria_extension_tosca.simple_v1_0.RelationshipDefinition
+ aria_extension_tosca.simple_v1_0.RequirementDefinition
+ aria_extension_tosca.simple_v1_0.CapabilityDefinition
+
+Filters
+-------
+
+.. autosummary::
+ :nosignatures:
+
+ aria_extension_tosca.simple_v1_0.CapabilityFilter
+ aria_extension_tosca.simple_v1_0.NodeFilter
+
+Miscellaneous
+-------------
+
+.. autosummary::
+ :nosignatures:
+
+ aria_extension_tosca.simple_v1_0.Description
+ aria_extension_tosca.simple_v1_0.MetaData
+ aria_extension_tosca.simple_v1_0.Repository
+ aria_extension_tosca.simple_v1_0.Import
+ aria_extension_tosca.simple_v1_0.ConstraintClause
+ aria_extension_tosca.simple_v1_0.EntrySchema
+ aria_extension_tosca.simple_v1_0.OperationImplementation
+ aria_extension_tosca.simple_v1_0.SubstitutionMappingsRequirement
+ aria_extension_tosca.simple_v1_0.SubstitutionMappingsCapability
+ aria_extension_tosca.simple_v1_0.SubstitutionMappings
+
+Templates
+---------
+
+.. autosummary::
+ :nosignatures:
+
+ aria_extension_tosca.simple_v1_0.NodeTemplate
+ aria_extension_tosca.simple_v1_0.RelationshipTemplate
+ aria_extension_tosca.simple_v1_0.GroupTemplate
+ aria_extension_tosca.simple_v1_0.PolicyTemplate
+ aria_extension_tosca.simple_v1_0.TopologyTemplate
+ aria_extension_tosca.simple_v1_0.ServiceTemplate
+
+Types
+-----
+
+.. autosummary::
+ :nosignatures:
+
+ aria_extension_tosca.simple_v1_0.ArtifactType
+ aria_extension_tosca.simple_v1_0.DataType
+ aria_extension_tosca.simple_v1_0.CapabilityType
+ aria_extension_tosca.simple_v1_0.InterfaceType
+ aria_extension_tosca.simple_v1_0.RelationshipType
+ aria_extension_tosca.simple_v1_0.NodeType
+ aria_extension_tosca.simple_v1_0.GroupType
+ aria_extension_tosca.simple_v1_0.PolicyType
+
+Data types
+----------
+
+.. autosummary::
+ :nosignatures:
+
+ aria_extension_tosca.simple_v1_0.Timestamp
+ aria_extension_tosca.simple_v1_0.Version
+ aria_extension_tosca.simple_v1_0.Range
+ aria_extension_tosca.simple_v1_0.List
+ aria_extension_tosca.simple_v1_0.Map
+ aria_extension_tosca.simple_v1_0.ScalarSize
+ aria_extension_tosca.simple_v1_0.ScalarTime
+ aria_extension_tosca.simple_v1_0.ScalarFrequency
+"""
+
from .presenter import ToscaSimplePresenter1_0
from .assignments import (PropertyAssignment, OperationAssignment, InterfaceAssignment,
RelationshipAssignment, RequirementAssignment, AttributeAssignment,
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/extensions/aria_extension_tosca/simple_v1_0/assignments.py
----------------------------------------------------------------------
diff --git a/extensions/aria_extension_tosca/simple_v1_0/assignments.py b/extensions/aria_extension_tosca/simple_v1_0/assignments.py
index 79f6377..0590527 100644
--- a/extensions/aria_extension_tosca/simple_v1_0/assignments.py
+++ b/extensions/aria_extension_tosca/simple_v1_0/assignments.py
@@ -61,7 +61,7 @@ class OperationAssignment(ExtensiblePresentation):
"""
The optional description string for the associated named operation.
- :rtype: :class:`Description`
+ :type: :class:`Description`
"""
@object_field(OperationImplementation)
@@ -70,7 +70,7 @@ class OperationAssignment(ExtensiblePresentation):
The optional implementation artifact name (e.g., a script file name within a TOSCA CSAR
file).
- :rtype: :class:`OperationImplementation`
+ :type: :class:`OperationImplementation`
"""
@object_dict_field(PropertyAssignment)
@@ -81,7 +81,7 @@ class OperationAssignment(ExtensiblePresentation):
when operation definitions are included as part of a Requirement assignment in a Node
Template.
- :rtype: dict of str, :class:`PropertyAssignment`
+ :type: {:obj:`basestring`: :class:`PropertyAssignment`}
"""
@cachedmethod
@@ -124,13 +124,13 @@ class InterfaceAssignment(ExtensiblePresentation):
when interface definitions are referenced as part of a Requirement assignment in a Node
Template.
- :rtype: dict of str, :class:`PropertyAssignment`
+ :type: {:obj:`basestring`: :class:`PropertyAssignment`}
"""
@object_dict_unknown_fields(OperationAssignment)
def operations(self):
"""
- :rtype: dict of str, :class:`OperationAssignment`
+ :type: {:obj:`basestring`: :class:`OperationAssignment`}
"""
@cachedmethod
@@ -157,6 +157,10 @@ class InterfaceAssignment(ExtensiblePresentation):
@short_form_field('type')
@has_fields
class RelationshipAssignment(ExtensiblePresentation):
+ """
+ Relationship assignment.
+ """
+
@field_validator(relationship_template_or_type_validator)
@primitive_field(str)
def type(self):
@@ -164,7 +168,7 @@ class RelationshipAssignment(ExtensiblePresentation):
The optional reserved keyname used to provide the name of the Relationship Type for the
requirement assignment's relationship keyname.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_dict_field(PropertyAssignment)
@@ -172,7 +176,7 @@ class RelationshipAssignment(ExtensiblePresentation):
"""
ARIA NOTE: This field is not mentioned in the spec, but is implied.
- :rtype: dict of str, :class:`PropertyAssignment`
+ :type: {:obj:`basestring`: :class:`PropertyAssignment`}
"""
@object_dict_field(InterfaceAssignment)
@@ -182,7 +186,7 @@ class RelationshipAssignment(ExtensiblePresentation):
the corresponding Relationship Type in order to provide Property assignments for these
interfaces or operations of these interfaces.
- :rtype: dict of str, :class:`InterfaceAssignment`
+ :type: {:obj:`basestring`: :class:`InterfaceAssignment`}
"""
@cachedmethod
@@ -224,7 +228,7 @@ class RequirementAssignment(ExtensiblePresentation):
* Capability Type that the provider will use to select a type-compatible target node
template to fulfill the requirement at runtime.
- :rtype: str
+ :type: :obj:`basestring`
"""
@field_validator(node_template_or_type_validator)
@@ -238,7 +242,7 @@ class RequirementAssignment(ExtensiblePresentation):
* Node Type name that the provider will use to select a type-compatible node template to
fulfill the requirement at runtime.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_field(RelationshipAssignment)
@@ -251,7 +255,7 @@ class RequirementAssignment(ExtensiblePresentation):
* Relationship Type that the provider will use to select a type-compatible relationship
template to relate the source node to the target node at runtime.
- :rtype: :class:`RelationshipAssignment`
+ :type: :class:`RelationshipAssignment`
"""
@field_validator(node_filter_validator)
@@ -261,7 +265,7 @@ class RequirementAssignment(ExtensiblePresentation):
The optional filter definition that TOSCA orchestrators or providers would use to select a
type-compatible target node that can fulfill the associated abstract requirement at runtime.
- :rtype: :class:`NodeFilter`
+ :type: :class:`NodeFilter`
"""
@cachedmethod
@@ -325,7 +329,7 @@ class CapabilityAssignment(ExtensiblePresentation):
"""
An optional list of property definitions for the Capability definition.
- :rtype: dict of str, :class:`PropertyAssignment`
+ :type: {:obj:`basestring`: :class:`PropertyAssignment`}
"""
@object_dict_field(AttributeAssignment)
@@ -333,7 +337,7 @@ class CapabilityAssignment(ExtensiblePresentation):
"""
An optional list of attribute definitions for the Capability definition.
- :rtype: dict of str, :class:`AttributeAssignment`
+ :type: {:obj:`basestring`: :class:`AttributeAssignment`}
"""
@cachedmethod
@@ -370,7 +374,7 @@ class ArtifactAssignment(ExtensiblePresentation):
"""
The required artifact type for the artifact definition.
- :rtype: str
+ :type: :obj:`basestring`
"""
@primitive_field(str, required=True)
@@ -379,7 +383,7 @@ class ArtifactAssignment(ExtensiblePresentation):
The required URI string (relative or absolute) which can be used to locate the artifact's
file.
- :rtype: str
+ :type: :obj:`basestring`
"""
@field_validator(type_validator('repository', 'repositories'))
@@ -390,7 +394,7 @@ class ArtifactAssignment(ExtensiblePresentation):
repository that contains the artifact. The artifact is expected to be referenceable by its
file URI within the repository.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_field(Description)
@@ -398,7 +402,7 @@ class ArtifactAssignment(ExtensiblePresentation):
"""
The optional description for the artifact definition.
- :rtype: :class:`Description`
+ :type: :class:`Description`
"""
@primitive_field(str)
@@ -406,7 +410,7 @@ class ArtifactAssignment(ExtensiblePresentation):
"""
The file path the associated file would be deployed into within the target node's container.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_dict_field(PropertyAssignment)
@@ -414,7 +418,7 @@ class ArtifactAssignment(ExtensiblePresentation):
"""
ARIA NOTE: This field is not mentioned in the spec, but is implied.
- :rtype: dict of str, :class:`PropertyAssignment`
+ :type: {:obj:`basestring`: :class:`PropertyAssignment`}
"""
@cachedmethod
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/extensions/aria_extension_tosca/simple_v1_0/definitions.py
----------------------------------------------------------------------
diff --git a/extensions/aria_extension_tosca/simple_v1_0/definitions.py b/extensions/aria_extension_tosca/simple_v1_0/definitions.py
index 8564249..1bd0366 100644
--- a/extensions/aria_extension_tosca/simple_v1_0/definitions.py
+++ b/extensions/aria_extension_tosca/simple_v1_0/definitions.py
@@ -42,7 +42,7 @@ class PropertyDefinition(ExtensiblePresentation):
an entity defined in this specification (e.g., Node Types, Relationship Types, Capability Types,
etc.). Properties are used by template authors to provide input values to TOSCA entities which
indicate their "desired state" when they are instantiated. The value of a property can be
- retrieved using the :code:`get_property` function within TOSCA Service Templates.
+ retrieved using the ``get_property`` function within TOSCA Service Templates.
See the `TOSCA Simple Profile v1.0 cos01 specification <http://docs.oasis-open.org/tosca
/TOSCA-Simple-Profile-YAML/v1.0/cos01/TOSCA-Simple-Profile-YAML-v1.0-cos01.html
@@ -55,7 +55,7 @@ class PropertyDefinition(ExtensiblePresentation):
"""
The required data type for the property.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_field(Description)
@@ -63,7 +63,7 @@ class PropertyDefinition(ExtensiblePresentation):
"""
The optional description for the property.
- :rtype: :class:`Description`
+ :type: :class:`Description`
"""
@primitive_field(bool, default=True)
@@ -71,7 +71,7 @@ class PropertyDefinition(ExtensiblePresentation):
"""
An optional key that declares a property as required (true) or not (false).
- :rtype: bool
+ :type: bool
"""
@field_validator(data_value_validator)
@@ -81,7 +81,7 @@ class PropertyDefinition(ExtensiblePresentation):
An optional key that may provide a value to be used as a default if not provided by another
means.
- :rtype: str
+ :type: :obj:`basestring`
"""
@primitive_field(str, default='supported', allowed=('supported', 'unsupported', 'experimental',
@@ -91,7 +91,7 @@ class PropertyDefinition(ExtensiblePresentation):
"""
The optional status of the property relative to the specification or implementation.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_list_field(ConstraintClause)
@@ -99,7 +99,7 @@ class PropertyDefinition(ExtensiblePresentation):
"""
The optional list of sequenced constraint clauses for the property.
- :rtype: list of (str, :class:`ConstraintClause`)
+ :type: list of (str, :class:`ConstraintClause`)
"""
@field_validator(entry_schema_validator)
@@ -109,7 +109,7 @@ class PropertyDefinition(ExtensiblePresentation):
The optional key that is used to declare the name of the Datatype definition for entries of
set types such as the TOSCA list or map.
- :rtype: str
+ :type: :obj:`basestring`
"""
@cachedmethod
@@ -128,7 +128,7 @@ class AttributeDefinition(ExtensiblePresentation):
defined in this specification (e.g., a Node, Relationship or Capability Type). Specifically, it
is used to expose the "actual state" of some property of a TOSCA entity after it has been
deployed and instantiated (as set by the TOSCA orchestrator). Attribute values can be retrieved
- via the :code:`get_attribute` function from the instance model and used as values to other
+ via the ``get_attribute`` function from the instance model and used as values to other
entities within TOSCA Service Templates.
See the `TOSCA Simple Profile v1.0 cos01 specification <http://docs.oasis-open.org/tosca
@@ -142,7 +142,7 @@ class AttributeDefinition(ExtensiblePresentation):
"""
The required data type for the attribute.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_field(Description)
@@ -150,7 +150,7 @@ class AttributeDefinition(ExtensiblePresentation):
"""
The optional description for the attribute.
- :rtype: :class:`Description`
+ :type: :class:`Description`
"""
@field_validator(data_value_validator)
@@ -163,7 +163,7 @@ class AttributeDefinition(ExtensiblePresentation):
This value SHALL be type compatible with the type declared by the property definition's type
keyname.
- :rtype: str
+ :type: :obj:`basestring`
"""
@primitive_field(str, default='supported', allowed=('supported', 'unsupported', 'experimental',
@@ -172,7 +172,7 @@ class AttributeDefinition(ExtensiblePresentation):
"""
The optional status of the attribute relative to the specification or implementation.
- :rtype: str
+ :type: :obj:`basestring`
"""
@field_validator(entry_schema_validator)
@@ -182,7 +182,7 @@ class AttributeDefinition(ExtensiblePresentation):
The optional key that is used to declare the name of the Datatype definition for entries of
set types such as the TOSCA list or map.
- :rtype: str
+ :type: :obj:`basestring`
"""
@cachedmethod
@@ -212,7 +212,7 @@ class ParameterDefinition(PropertyDefinition):
Note: This keyname is required for a TOSCA Property definition, but is not for a TOSCA
Parameter definition.
- :rtype: str
+ :type: :obj:`basestring`
"""
@field_validator(data_value_validator)
@@ -241,7 +241,7 @@ class OperationDefinition(ExtensiblePresentation):
"""
The optional description string for the associated named operation.
- :rtype: :class:`Description`
+ :type: :class:`Description`
"""
@object_field(OperationImplementation)
@@ -250,7 +250,7 @@ class OperationDefinition(ExtensiblePresentation):
The optional implementation artifact name (e.g., a script file name within a TOSCA CSAR
file).
- :rtype: :class:`OperationImplementation`
+ :type: :class:`OperationImplementation`
"""
@object_dict_field(PropertyDefinition)
@@ -261,7 +261,7 @@ class OperationDefinition(ExtensiblePresentation):
includes when interface definitions are included as part of a Requirement definition in a
Node Type.
- :rtype: dict of str, :class:`PropertyDefinition`
+ :type: {:obj:`basestring`: :class:`PropertyDefinition`}
"""
@allow_unknown_fields
@@ -284,7 +284,7 @@ class InterfaceDefinition(ExtensiblePresentation):
"""
ARIA NOTE: This field is not mentioned in the spec, but is implied.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_dict_field(PropertyDefinition)
@@ -295,13 +295,13 @@ class InterfaceDefinition(ExtensiblePresentation):
includes when interface definitions are included as part of a Requirement definition in a
Node Type.
- :rtype: dict of str, :class:`PropertyDefinition`
+ :type: {:obj:`basestring`: :class:`PropertyDefinition`}
"""
@object_dict_unknown_fields(OperationDefinition)
def operations(self):
"""
- :rtype: dict of str, :class:`OperationDefinition`
+ :type: {:obj:`basestring`: :class:`OperationDefinition`}
"""
@cachedmethod
@@ -325,6 +325,10 @@ class InterfaceDefinition(ExtensiblePresentation):
@short_form_field('type')
@has_fields
class RelationshipDefinition(ExtensiblePresentation):
+ """
+ Relationship definition.
+ """
+
@field_validator(type_validator('relationship type', convert_shorthand_to_full_type_name,
'relationship_types'))
@primitive_field(str, required=True)
@@ -333,7 +337,7 @@ class RelationshipDefinition(ExtensiblePresentation):
The optional reserved keyname used to provide the name of the Relationship Type for the
requirement definition's relationship keyname.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_dict_field(InterfaceDefinition)
@@ -343,7 +347,7 @@ class RelationshipDefinition(ExtensiblePresentation):
the corresponding Relationship Type in order to declare additional Property definitions for
these interfaces or operations of these interfaces.
- :rtype: list of :class:`InterfaceDefinition`
+ :type: list of :class:`InterfaceDefinition`
"""
@cachedmethod
@@ -375,7 +379,7 @@ class RequirementDefinition(ExtensiblePresentation):
The required reserved keyname used that can be used to provide the name of a valid
Capability Type that can fulfill the requirement.
- :rtype: str
+ :type: :obj:`basestring`
"""
@field_validator(type_validator('node type', convert_shorthand_to_full_type_name, 'node_types'))
@@ -385,7 +389,7 @@ class RequirementDefinition(ExtensiblePresentation):
The optional reserved keyname used to provide the name of a valid Node Type that contains
the capability definition that can be used to fulfill the requirement.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_field(RelationshipDefinition)
@@ -394,7 +398,7 @@ class RequirementDefinition(ExtensiblePresentation):
The optional reserved keyname used to provide the name of a valid Relationship Type to
construct when fulfilling the requirement.
- :rtype: :class:`RelationshipDefinition`
+ :type: :class:`RelationshipDefinition`
"""
@field_getter(data_type_class_getter(Range))
@@ -405,7 +409,7 @@ class RequirementDefinition(ExtensiblePresentation):
Note: the keyword UNBOUNDED is also supported to represent any positive integer.
- :rtype: :class:`Range`
+ :type: :class:`Range`
"""
@cachedmethod
@@ -437,7 +441,7 @@ class CapabilityDefinition(ExtensiblePresentation):
"""
The required name of the Capability Type the capability definition is based upon.
- :rtype: str
+ :type: :obj:`basestring`
"""
@object_field(Description)
@@ -445,7 +449,7 @@ class CapabilityDefinition(ExtensiblePresentation):
"""
The optional description of the Capability definition.
- :rtype: :class:`Description`
+ :type: :class:`Description`
"""
@object_dict_field(PropertyDefinition)
@@ -453,7 +457,7 @@ class CapabilityDefinition(ExtensiblePresentation):
"""
An optional list of property definitions for the Capability definition.
- :rtype: dict of str, :class:`PropertyDefinition`
+ :type: {:obj:`basestring`: :class:`PropertyDefinition`}
"""
@object_dict_field(AttributeDefinition)
@@ -461,7 +465,7 @@ class CapabilityDefinition(ExtensiblePresentation):
"""
An optional list of attribute definitions for the Capability definition.
- :rtype: dict of str, :class:`AttributeDefinition`
+ :type: {:obj:`basestring`: :class:`AttributeDefinition`}
"""
@field_validator(list_type_validator('node type', convert_shorthand_to_full_type_name,
@@ -472,7 +476,7 @@ class CapabilityDefinition(ExtensiblePresentation):
An optional list of one or more valid names of Node Types that are supported as valid
sources of any relationship established to the declared Capability Type.
- :rtype: list of str
+ :type: [:obj:`basestring`]
"""
@field_getter(data_type_class_getter(Range))
@@ -481,14 +485,15 @@ class CapabilityDefinition(ExtensiblePresentation):
"""
The optional minimum and maximum occurrences for the capability. By default, an exported
Capability should allow at least one relationship to be formed with it with a maximum of
- :code:`UNBOUNDED` relationships.
+ ``UNBOUNDED`` relationships.
- Note: the keyword :code:`UNBOUNDED` is also supported to represent any positive integer.
+ Note: the keyword ``UNBOUNDED`` is also supported to represent any positive integer.
- ARIA NOTE: The spec seems wrong here: the implied default should be [0,UNBOUNDED], not
- [1,UNBOUNDED], otherwise it would imply that at 1 least one relationship *must* be formed.
+ ARIA NOTE: The spec seems wrong here: the implied default should be ``[0,UNBOUNDED]``, not
+ ``[1,UNBOUNDED]``, otherwise it would imply that at 1 least one relationship *must* be
+ formed.
- :rtype: :class:`Range`
+ :type: :class:`Range`
"""
@cachedmethod
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/2ed2e1c2/extensions/aria_extension_tosca/simple_v1_0/filters.py
----------------------------------------------------------------------
diff --git a/extensions/aria_extension_tosca/simple_v1_0/filters.py b/extensions/aria_extension_tosca/simple_v1_0/filters.py
index 838b505..6db140d 100644
--- a/extensions/aria_extension_tosca/simple_v1_0/filters.py
+++ b/extensions/aria_extension_tosca/simple_v1_0/filters.py
@@ -24,6 +24,10 @@ from .presentation.field_validators import (node_filter_properties_validator,
@has_fields
class CapabilityFilter(ExtensiblePresentation):
+ """
+ Capability filter.
+ """
+
@object_sequenced_list_field(ConstraintClause)
def properties(self):
pass
@@ -69,7 +73,7 @@ class NodeFilter(ExtensiblePresentation):
/TOSCA-Simple-Profile-YAML/v1.0/cos01/TOSCA-Simple-Profile-YAML-v1.0-cos01.html
#DEFN_ELEMENT_PROPERTY_FILTER_DEFN>`__
- :rtype: list of (str, :class:`ConstraintClause`)
+ :type: list of (str, :class:`ConstraintClause`)
"""
@field_validator(node_filter_capabilities_validator)
@@ -80,7 +84,7 @@ class NodeFilter(ExtensiblePresentation):
matching TOSCA entities (e.g., Node Template, Node Type, Capability Types, etc.) based upon
their capabilities' property definitions' values.
- :rtype: list of (str, :class:`CapabilityDefinition`)
+ :type: list of (str, :class:`CapabilityDefinition`)
"""
@cachedmethod