Skip to content

Commit

Permalink
sphinx build from Action e2dfea7
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Apr 23, 2024
1 parent 88a9258 commit ec676b8
Show file tree
Hide file tree
Showing 16 changed files with 31 additions and 29 deletions.
5 changes: 3 additions & 2 deletions python_sdk/_sources/changelog.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ All notable changes to this project will be documented in this file.
The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.

Unreleased
----------
0.16.1 (April-23-2024)
----------------------

* Always use extended headers
* Add Delete Media HTTP API's
* Add port argument to Preview Stream HTTP API
* Only ask for sudo password when required
Expand Down
20 changes: 10 additions & 10 deletions python_sdk/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -9587,7 +9587,7 @@ <h2>Common Interface<a class="headerlink" href="#common-interface" title="Permal

<dl class="py method">
<dt class="sig sig-object py" id="open_gopro.ble.controller.BLEController.read">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BleHandle</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#open_gopro.ble.services.BleUUID" title="open_gopro.ble.services.BleUUID"><span class="pre">BleUUID</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bytearray</span></span></span><a class="headerlink" href="#open_gopro.ble.controller.BLEController.read" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BleHandle</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#open_gopro.ble.services.BleUUID" title="open_gopro.ble.services.BleUUID"><span class="pre">BleUUID</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#open_gopro.ble.controller.BLEController.read" title="Permalink to this definition"></a></dt>
<dd><p>Read a bytestream response from a BleUUID.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand All @@ -9600,7 +9600,7 @@ <h2>Common Interface<a class="headerlink" href="#common-interface" title="Permal
<dd class="field-even"><p>response</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bytearray</p>
<dd class="field-odd"><p>bytes</p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -9628,21 +9628,21 @@ <h2>Common Interface<a class="headerlink" href="#common-interface" title="Permal

<dl class="py method">
<dt class="sig sig-object py" id="open_gopro.ble.controller.BLEController.write">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">write</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BleHandle</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#open_gopro.ble.services.BleUUID" title="open_gopro.ble.services.BleUUID"><span class="pre">BleUUID</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytearray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#open_gopro.ble.controller.BLEController.write" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">write</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BleHandle</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#open_gopro.ble.services.BleUUID" title="open_gopro.ble.services.BleUUID"><span class="pre">BleUUID</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#open_gopro.ble.controller.BLEController.write" title="Permalink to this definition"></a></dt>
<dd><p>Write a bytestream to a BleUUID.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>handle</strong> (<em>BleHandle</em>) – handle to pair to</p></li>
<li><p><strong>uuid</strong> (<a class="reference internal" href="#open_gopro.ble.services.BleUUID" title="open_gopro.ble.services.BleUUID"><em>BleUUID</em></a>) – BleUUID to write to</p></li>
<li><p><strong>data</strong> (<em>bytearray</em>) – bytestream to write</p></li>
<li><p><strong>data</strong> (<em>bytes</em>) – bytestream to write</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>response</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bytearray</p>
<dd class="field-odd"><p>bytes</p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -9739,7 +9739,7 @@ <h2>Common Interface<a class="headerlink" href="#common-interface" title="Permal

<dl class="py method">
<dt class="sig sig-object py" id="open_gopro.ble.client.BleClient.read">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#open_gopro.ble.services.BleUUID" title="open_gopro.ble.services.BleUUID"><span class="pre">BleUUID</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bytearray</span></span></span><a class="headerlink" href="#open_gopro.ble.client.BleClient.read" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#open_gopro.ble.services.BleUUID" title="open_gopro.ble.services.BleUUID"><span class="pre">BleUUID</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#open_gopro.ble.client.BleClient.read" title="Permalink to this definition"></a></dt>
<dd><p>Read byte data from a characteristic (identified by BleUUID)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand All @@ -9749,7 +9749,7 @@ <h2>Common Interface<a class="headerlink" href="#common-interface" title="Permal
<dd class="field-even"><p>byte data that was read</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bytearray</p>
<dd class="field-odd"><p>bytes</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -9767,13 +9767,13 @@ <h2>Common Interface<a class="headerlink" href="#common-interface" title="Permal

<dl class="py method">
<dt class="sig sig-object py" id="open_gopro.ble.client.BleClient.write">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">write</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#open_gopro.ble.services.BleUUID" title="open_gopro.ble.services.BleUUID"><span class="pre">BleUUID</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytearray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#open_gopro.ble.client.BleClient.write" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">write</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#open_gopro.ble.services.BleUUID" title="open_gopro.ble.services.BleUUID"><span class="pre">BleUUID</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#open_gopro.ble.client.BleClient.write" title="Permalink to this definition"></a></dt>
<dd><p>Write byte data to a characteristic (identified by BleUUID)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>uuid</strong> (<a class="reference internal" href="#open_gopro.ble.services.BleUUID" title="open_gopro.ble.services.BleUUID"><em>BleUUID</em></a>) – characteristic to write to</p></li>
<li><p><strong>data</strong> (<em>bytearray</em>) – byte data to write</p></li>
<li><p><strong>data</strong> (<em>bytes</em>) – byte data to write</p></li>
</ul>
</dd>
</dl>
Expand Down
2 changes: 1 addition & 1 deletion python_sdk/authors.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
9 changes: 5 additions & 4 deletions python_sdk/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand All @@ -58,7 +58,7 @@
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Credits</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</a></li>
<li class="toctree-l2"><a class="reference internal" href="#april-23-2024">0.16.1 (April-23-2024)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#april-9-2024">0.16.0 (April-9-2024)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#december-6-2023">0.15.1 (December-6-2023)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id1">0.15.0 (December-6-2023)</a></li>
Expand Down Expand Up @@ -138,9 +138,10 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
<p>All notable changes to this project will be documented in this file.</p>
<p>The format is based on <a class="reference external" href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
and this project adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
<section id="unreleased">
<h2>Unreleased<a class="headerlink" href="#unreleased" title="Permalink to this heading"></a></h2>
<section id="april-23-2024">
<h2>0.16.1 (April-23-2024)<a class="headerlink" href="#april-23-2024" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>Always use extended headers</p></li>
<li><p>Add Delete Media HTTP API’s</p></li>
<li><p>Add port argument to Preview Stream HTTP API</p></li>
<li><p>Only ask for sudo password when required</p></li>
Expand Down
2 changes: 1 addition & 1 deletion python_sdk/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion python_sdk/future_work.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion python_sdk/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions python_sdk/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -998,7 +998,7 @@ <h2>Development<a class="headerlink" href="#development" title="Permalink to thi
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">Unreleased</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#april-23-2024">0.16.1 (April-23-2024)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#april-9-2024">0.16.0 (April-9-2024)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#december-6-2023">0.15.1 (December-6-2023)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">0.15.0 (December-6-2023)</a></li>
Expand Down
2 changes: 1 addition & 1 deletion python_sdk/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Binary file modified python_sdk/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion python_sdk/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion python_sdk/quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion python_sdk/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
Expand Down
2 changes: 1 addition & 1 deletion python_sdk/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion python_sdk/troubleshooting.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion python_sdk/usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Open GoPro Python SDK
</a>
<div class="version">
0.16.0
0.16.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down

0 comments on commit ec676b8

Please sign in to comment.