Skip to content

Commit

Permalink
Merge pull request #51 from nikhilym/doc_changes
Browse files Browse the repository at this point in the history
Add missing model docs
  • Loading branch information
nikhilym committed Nov 26, 2018
2 parents 6cac5df + e498cb1 commit d6907d8
Show file tree
Hide file tree
Showing 11 changed files with 75 additions and 122 deletions.
4 changes: 0 additions & 4 deletions docs/en/models/ask_sdk_model.dialog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,25 @@ ask\_sdk\_model.dialog.confirm\_intent\_directive module

.. automodule:: ask_sdk_model.dialog.confirm_intent_directive
:members:
:undoc-members:
:show-inheritance:

ask\_sdk\_model.dialog.confirm\_slot\_directive module
------------------------------------------------------

.. automodule:: ask_sdk_model.dialog.confirm_slot_directive
:members:
:undoc-members:
:show-inheritance:

ask\_sdk\_model.dialog.delegate\_directive module
-------------------------------------------------

.. automodule:: ask_sdk_model.dialog.delegate_directive
:members:
:undoc-members:
:show-inheritance:

ask\_sdk\_model.dialog.elicit\_slot\_directive module
-----------------------------------------------------

.. automodule:: ask_sdk_model.dialog.elicit_slot_directive
:members:
:undoc-members:
:show-inheritance:
94 changes: 41 additions & 53 deletions docs/en/models/ask_sdk_model.interfaces.alexa.presentation.apl.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
ask_sdk_model.interfaces.alexa.presentation.apl package
=======================================================
ask\_sdk\_model.interfaces.alexa.presentation.apl package
=========================================================

Submodules
----------
~~~~~~~~~~

.. note::

Expand All @@ -14,107 +14,95 @@ Submodules
``class C``, you can do ``from a import C`` instead of
``from a.b import C``.

alexa.presentation.apl.alexa\_presentation\_apl\_interface module
-----------------------------------------------------------------

.. automodule:: alexa.presentation.apl.alexa_presentation_apl_interface
ask\_sdk\_model.interfaces.alexa.presentation.apl.alexa\_presentation\_apl\_interface module
--------------------------------------------------------------------------------------------

.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.alexa_presentation_apl_interface
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.align module
-----------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.align module
--------------------------------------------------------------

.. automodule:: alexa.presentation.apl.align
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.align
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.auto\_page\_command module
-------------------------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.auto\_page\_command module
----------------------------------------------------------------------------

.. automodule:: alexa.presentation.apl.auto_page_command
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.auto_page_command
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.command module
-------------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.command module
----------------------------------------------------------------

.. automodule:: alexa.presentation.apl.command
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.command
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.execute\_commands\_directive module
----------------------------------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.execute\_commands\_directive module
-------------------------------------------------------------------------------------

.. automodule:: alexa.presentation.apl.execute_commands_directive
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.execute_commands_directive
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.highlight\_mode module
---------------------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.highlight\_mode module
------------------------------------------------------------------------

.. automodule:: alexa.presentation.apl.highlight_mode
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.highlight_mode
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.position module
--------------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.position module
-----------------------------------------------------------------

.. automodule:: alexa.presentation.apl.position
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.position
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.render\_document\_directive module
---------------------------------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.render\_document\_directive module
------------------------------------------------------------------------------------

.. automodule:: alexa.presentation.apl.render_document_directive
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.render_document_directive
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.runtime module
-------------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.runtime module
----------------------------------------------------------------

.. automodule:: alexa.presentation.apl.runtime
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.runtime
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.set\_page\_command module
------------------------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.set\_page\_command module
---------------------------------------------------------------------------

.. automodule:: alexa.presentation.apl.set_page_command
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.set_page_command
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.speak\_item\_command module
--------------------------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.speak\_item\_command module
-----------------------------------------------------------------------------

.. automodule:: alexa.presentation.apl.speak_item_command
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.speak_item_command
:members:
:undoc-members:
:show-inheritance:

alexa.presentation.apl.user\_event module
-----------------------------------------
ask\_sdk\_model.interfaces.alexa.presentation.apl.user\_event module
--------------------------------------------------------------------

.. automodule:: alexa.presentation.apl.user_event
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl.user_event
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: alexa.presentation.apl
.. automodule:: ask_sdk_model.interfaces.alexa.presentation.apl
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
ask_sdk_model.interfaces.alexa.presentation package
ask\_sdk\_model.interfaces.alexa.presentation package
===================================================

Subpackages
-----------

.. toctree::
:maxdepth: 1

alexa.presentation.apl
ask_sdk_model.interfaces.alexa.presentation.apl

Module contents
---------------

.. automodule:: alexa.presentation
.. automodule:: ask_sdk_model.interfaces.alexa.presentation
:members:
:undoc-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/en/models/ask_sdk_model.interfaces.alexa.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Subpackages
-----------

.. toctree::
:maxdepth: 1

alexa.presentation
ask_sdk_model.interfaces.alexa.presentation

Module contents
---------------

.. automodule:: alexa
.. automodule:: ask_sdk_model.interfaces.alexa
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
Expand Up @@ -59,34 +59,6 @@ ask\_sdk\_model.interfaces.amazonpay.model.request.provider\_attributes module
ask\_sdk\_model.interfaces.amazonpay.model.request.provider\_credit module
----------------------------------------------------------------

.. automodule:: ask_sdk_model.interfaces.amazonpay.model.request.provider_credit
:members:
:show-inheritance:

ask\_sdk\_model.interfaces.amazonpay.model.request.payment\_action module
--------------------------------------------------------------------

.. automodule:: ask_sdk_model.interfaces.amazonpay.model.request.payment_action
:members:
:show-inheritance:

ask\_sdk\_model.interfaces.amazonpay.model.request.price module
----------------------------------------------------------

.. automodule:: ask_sdk_model.interfaces.amazonpay.model.request.price
:members:
:show-inheritance:

ask\_sdk\_model.interfaces.amazonpay.model.request.provider\_attributes module
-------------------------------------------------------------------------

.. automodule:: ask_sdk_model.interfaces.amazonpay.model.request.provider_attributes
:members:
:show-inheritance:

ask\_sdk\_model.interfaces.amazonpay.model.request.provider\_credit module
---------------------------------------------------------------------

.. automodule:: ask_sdk_model.interfaces.amazonpay.model.request.provider_credit
:members:
:show-inheritance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Subpackages
-----------

.. toctree::
:maxdepth: 1

ask_sdk_model.interfaces.amazonpay.model.v1
ask_sdk_model.interfaces.amazonpay.model.request
Expand Down
1 change: 1 addition & 0 deletions docs/en/models/ask_sdk_model.interfaces.amazonpay.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Subpackages
-----------

.. toctree::
:maxdepth: 1

ask_sdk_model.interfaces.amazonpay.model
ask_sdk_model.interfaces.amazonpay.v1
Expand Down
5 changes: 0 additions & 5 deletions docs/en/models/ask_sdk_model.interfaces.amazonpay.v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,37 +19,32 @@ ask\_sdk\_model.interfaces.amazonpay.v1.amazon\_pay\_error\_response module

.. automodule:: ask_sdk_model.interfaces.amazonpay.v1.amazon_pay_error_response
:members:
:undoc-members:
:show-inheritance:

ask\_sdk\_model.interfaces.amazonpay.v1.charge\_amazon\_pay module
------------------------------------------------------------------

.. automodule:: ask_sdk_model.interfaces.amazonpay.v1.charge_amazon_pay
:members:
:undoc-members:
:show-inheritance:

ask\_sdk\_model.interfaces.amazonpay.v1.charge\_amazon\_pay\_result module
--------------------------------------------------------------------------

.. automodule:: ask_sdk_model.interfaces.amazonpay.v1.charge_amazon_pay_result
:members:
:undoc-members:
:show-inheritance:

ask\_sdk\_model.interfaces.amazonpay.v1.setup\_amazon\_pay module
-----------------------------------------------------------------

.. automodule:: ask_sdk_model.interfaces.amazonpay.v1.setup_amazon_pay
:members:
:undoc-members:
:show-inheritance:

ask\_sdk\_model.interfaces.amazonpay.v1.setup\_amazon\_pay\_result module
-------------------------------------------------------------------------

.. automodule:: ask_sdk_model.interfaces.amazonpay.v1.setup_amazon_pay_result
:members:
:undoc-members:
:show-inheritance:
42 changes: 18 additions & 24 deletions docs/en/models/ask_sdk_model.interfaces.viewport.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
ask_sdk_model.interfaces.viewport package
=========================================
ask\_sdk\_model.interfaces.viewport package
===========================================

Submodules
----------
Expand All @@ -14,51 +14,45 @@ Submodules
``class C``, you can do ``from a import C`` instead of
``from a.b import C``.

viewport.experience module
--------------------------
ask\_sdk\_model.interfaces.viewport.experience module
-----------------------------------------------------

.. automodule:: viewport.experience
.. automodule:: ask_sdk_model.interfaces.viewport.experience
:members:
:undoc-members:
:show-inheritance:

viewport.keyboard module
------------------------
ask\_sdk\_model.interfaces.viewport.keyboard module
---------------------------------------------------

.. automodule:: viewport.keyboard
.. automodule:: ask_sdk_model.interfaces.viewport.keyboard
:members:
:undoc-members:
:show-inheritance:

viewport.shape module
---------------------
ask\_sdk\_model.interfaces.viewport.shape module
------------------------------------------------

.. automodule:: viewport.shape
.. automodule:: ask_sdk_model.interfaces.viewport.shape
:members:
:undoc-members:
:show-inheritance:

viewport.touch module
---------------------
ask\_sdk\_model.interfaces.viewport.touch module
------------------------------------------------

.. automodule:: viewport.touch
.. automodule:: ask_sdk_model.interfaces.viewport.touch
:members:
:undoc-members:
:show-inheritance:

viewport.viewport\_state module
-------------------------------
ask\_sdk\_model.interfaces.viewport.viewport\_state module
----------------------------------------------------------

.. automodule:: viewport.viewport_state
.. automodule:: ask_sdk_model.interfaces.viewport.viewport_state
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: viewport
.. automodule:: ask_sdk_model.interfaces.viewport
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/en/models/ask_sdk_model.services.directive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ ask\_sdk\_model.services.directive.directive module
.. automodule:: ask_sdk_model.services.directive.directive
:members:
:show-inheritance:
:exclude-members: attribute_map, deserialized_types, json_discriminator_key

ask\_sdk\_model.services.directive.directive\_service\_client module
--------------------------------------------------------------------
Expand Down
Loading

0 comments on commit d6907d8

Please sign in to comment.