Apply Pike document structure
This is step 2 of the doc-migration. The documentation structure has been changed according to the Pike documentation standard. Depends-on: I5d91dcd4a50b148eae4c2bf905cf52c8d5bbbe8e Change-Id: I302b7e18070e0de86c85559267a2c22ada656290
This commit is contained in:
parent
436f0137d1
commit
87a3f76418
|
@ -1,4 +0,0 @@
|
|||
============
|
||||
Contributing
|
||||
============
|
||||
.. include:: ../../CONTRIBUTING.rst
|
|
@ -18,7 +18,7 @@ How to write a Custom Action
|
|||
# Actions can be returned in a manner of ways. The simplest is
|
||||
# return {'status': 0}
|
||||
# or using a Result object. The Result has an optional parameter data
|
||||
# that can be used to transfer information
|
||||
# that can be used to transfer information
|
||||
return actions.Result()
|
||||
# Failed executions can also be returned using a workflow Result object
|
||||
# that contains an non empty error parameter such as:
|
|
@ -0,0 +1,8 @@
|
|||
=====================
|
||||
Developer's Reference
|
||||
=====================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
creating_custom_actions
|
|
@ -1,26 +1,43 @@
|
|||
.. mistral-lib 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 mistral-lib's documentation!
|
||||
=======================================
|
||||
|
||||
The mistral-lib is a library that contains data types, exceptions, functions
|
||||
and utilities common to Mistral, python-mistralclient and mistral-extra
|
||||
repositories. This library also contains the public interfaces for 3rd party
|
||||
integration (e.g. Actions API, YAQL functions API, etc.)
|
||||
|
||||
Contents:
|
||||
|
||||
Install guide
|
||||
-------------
|
||||
|
||||
**Installation**
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
installation
|
||||
usage
|
||||
contributing
|
||||
creating_custom_actions
|
||||
install/index
|
||||
|
||||
User guide
|
||||
----------
|
||||
|
||||
**Usage**
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
user/index
|
||||
|
||||
Developer guide
|
||||
---------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
contributor/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
|
|
@ -1 +0,0 @@
|
|||
.. include:: ../../README.rst
|
Loading…
Reference in New Issue