Skip to content

Commit

Permalink
Auto-commit for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bibi21000 committed Jun 8, 2015
1 parent 44c7f78 commit deb4922
Show file tree
Hide file tree
Showing 22 changed files with 1,416 additions and 1,230 deletions.
14 changes: 14 additions & 0 deletions DEVEL.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,20 @@ Some tests don't need a ZWave Stick to be launched, so they can be run
on the autobuilders (travis, docker, ...). Place them in the autobuild
directory.

Some tests need manual operations (ie to add a node, to remove one,
...). For example, to test the remove node, use :

export MANUALSKIP='False' && /usr/local/bin/nosetests --verbosity=2 tests/api/test_controller_command.py -m test_150 && unset MANUALSKIP
test_150_command_remove_node_and_wait_for_user (tests.api.test_controller_command.TestControllerCommand) ... ok

----------------------------------------------------------------------
Ran 1 test in 16.031s

OK

You should push the inclusion button of the node before the end of the
test.


Documentation
=============
Expand Down
14 changes: 14 additions & 0 deletions docs/DEVEL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,20 @@ Travis-ci, Docker Hub, nosetests and pylint are used to test quality of code. Th

Some tests don't need a ZWave Stick to be launched, so they can be run on the autobuilders (travis, docker, ...). Place them in the autobuild directory.

Some tests need manual operations (ie to add a node, to remove one, ...). For example, to test the remove node, use :

.. code-block:: bash
export MANUALSKIP='False' && /usr/local/bin/nosetests --verbosity=2 tests/api/test_controller_command.py -m test_150 && unset MANUALSKIP
test_150_command_remove_node_and_wait_for_user (tests.api.test_controller_command.TestControllerCommand) ... ok
----------------------------------------------------------------------
Ran 1 test in 16.031s
OK
You should push the inclusion button of the node before the end of the test.

Documentation
=============
Documentation is managed with sphinx.
Expand Down
11 changes: 11 additions & 0 deletions docs/html/DEVEL.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,17 @@ <h2>Tests<a class="headerlink" href="#tests" title="Permalink to this headline">
</ul>
</div></blockquote>
<p>Some tests don&#8217;t need a ZWave Stick to be launched, so they can be run on the autobuilders (travis, docker, ...). Place them in the autobuild directory.</p>
<p>Some tests need manual operations (ie to add a node, to remove one, ...). For example, to test the remove node, use :</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nb">export </span><span class="nv">MANUALSKIP</span><span class="o">=</span><span class="s1">&#39;False&#39;</span> <span class="o">&amp;&amp;</span> /usr/local/bin/nosetests --verbosity<span class="o">=</span>2 tests/api/test_controller_command.py -m test_150 <span class="o">&amp;&amp;</span> <span class="nb">unset </span>MANUALSKIP
test_150_command_remove_node_and_wait_for_user <span class="o">(</span>tests.api.test_controller_command.TestControllerCommand<span class="o">)</span> ... ok

----------------------------------------------------------------------
Ran 1 <span class="nb">test </span>in 16.031s

OK
</pre></div>
</div>
<p>You should push the inclusion button of the node before the end of the test.</p>
</div>
<div class="section" id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h2>
Expand Down
14 changes: 14 additions & 0 deletions docs/html/_sources/DEVEL.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,20 @@ Travis-ci, Docker Hub, nosetests and pylint are used to test quality of code. Th

Some tests don't need a ZWave Stick to be launched, so they can be run on the autobuilders (travis, docker, ...). Place them in the autobuild directory.

Some tests need manual operations (ie to add a node, to remove one, ...). For example, to test the remove node, use :

.. code-block:: bash

export MANUALSKIP='False' && /usr/local/bin/nosetests --verbosity=2 tests/api/test_controller_command.py -m test_150 && unset MANUALSKIP
test_150_command_remove_node_and_wait_for_user (tests.api.test_controller_command.TestControllerCommand) ... ok

----------------------------------------------------------------------
Ran 1 test in 16.031s

OK

You should push the inclusion button of the node before the end of the test.

Documentation
=============
Documentation is managed with sphinx.
Expand Down
28 changes: 16 additions & 12 deletions docs/html/controller.html
Original file line number Diff line number Diff line change
Expand Up @@ -698,10 +698,12 @@ <h1>Controller documentation<a class="headerlink" href="#controller-documentatio
<dl class="method">
<dt id="openzwave.controller.ZWaveController.has_node_failed">
<tt class="descname">has_node_failed</tt><big>(</big><em>nodeid</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.has_node_failed" title="Permalink to this definition"></a></dt>
<dd><p>Ask a Node to update its Neighbor Tables</p>
<p>This command will ask a Node to update its Neighbor Tables.</p>
<p>Results of the HasNodeFailed Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</p>
<dd><p>Check if the Controller Believes a Node has Failed.</p>
<blockquote>
<div><p>This is different from the IsNodeFailed call in that we test the Controllers Failed Node List, whereas the IsNodeFailed is testing
our list of Failed Nodes, which might be different.</p>
<p>The Results will be communicated via Notifications. Specifically, you should monitor the ControllerCommand notifications</p>
</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
Expand Down Expand Up @@ -972,10 +974,12 @@ <h1>Controller documentation<a class="headerlink" href="#controller-documentatio
<dl class="method">
<dt id="openzwave.controller.ZWaveController.remove_failed_node">
<tt class="descname">remove_failed_node</tt><big>(</big><em>nodeid</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.remove_failed_node" title="Permalink to this definition"></a></dt>
<dd><p>Check if the Controller Believes a Node has Failed.</p>
<p>This is different from the IsNodeFailed call in that we test the Controllers Failed Node List, whereas the IsNodeFailed is testing
our list of Failed Nodes, which might be different.</p>
<p>The Results will be communicated via Notifications. Specifically, you should monitor the ControllerCommand notifications</p>
<dd><p>Remove a Failed Device from the Z-Wave Network</p>
<p>This Command will remove a failed node from the network. The Node should be on the Controllers Failed
Node List, otherwise this command will fail. You can use the HasNodeFailed function below to test if the Controller
believes the Node has Failed.</p>
<p>The Status of the Node Removal is communicated via Notifications. Specifically, you should
monitor ControllerCommand Notifications.</p>
<p>Results of the RemoveFailedNode Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</p>
<table class="docutils field-list" frame="void" rules="none">
Expand Down Expand Up @@ -1039,10 +1043,10 @@ <h1>Controller documentation<a class="headerlink" href="#controller-documentatio
<dl class="method">
<dt id="openzwave.controller.ZWaveController.replication_send">
<tt class="descname">replication_send</tt><big>(</big><em>nodeid</em><big>)</big><a class="headerlink" href="#openzwave.controller.ZWaveController.replication_send" title="Permalink to this definition"></a></dt>
<dd><p>Create a handheld button id.</p>
<p>Only intended for Bridge Firmware Controllers.</p>
<p>Results of the ReplicationSend Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</p>
<dd><p>Send information from primary to secondary</p>
<blockquote>
<div>Results of the ReplicationSend Command will be send as a Notification with the Notification type as
Notification::Type_ControllerCommand</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
Expand Down
8 changes: 4 additions & 4 deletions docs/html/coverage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ <h1>Coverage report:
<tfoot>
<tr class='total'>
<td class='name left'>Total</td>
<td>4170</td>
<td>3215</td>
<td>4174</td>
<td>3219</td>
<td>4</td>

<td class='right'>23%</td>
Expand Down Expand Up @@ -103,8 +103,8 @@ <h1>Coverage report:

<tr class='file'>
<td class='name left'><a href='openzwave_network.html'>openzwave.network</a></td>
<td>549</td>
<td>549</td>
<td>553</td>
<td>553</td>
<td>0</td>

<td class='right'>0%</td>
Expand Down
Loading

0 comments on commit deb4922

Please sign in to comment.