sphinx build from Action 17c943e

python_sdk/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3ff48c3d1df897816f9240c192bade79
+config: e1cf076499f8757f43ff7be03bf7c7aa
 tags: 645f666f9bcd5a90fca523b33c5a78b7

python_sdk/_images/inheritance-ec5587989260a7277f9337e599e7e7025c68e6f1.png.map → python_sdk/_images/inheritance-16857ac0e1d01b66cb596a08c19027d331dd9b89.png.map

@@ -1,7 +1,7 @@
 <map id="inheritancef99e758f3f" name="inheritancef99e758f3f">
-<area shape="rect" id="node1" title="Helper class that provides a standard way to create an ABC using" alt="" coords="23,225,95,251"/>
+<area shape="rect" id="node1" href="https://docs.python.org/3/library/abc.html#abc.ABC" target="_top" title="Helper class that provides a standard way to create an ABC using" alt="" coords="23,225,95,251"/>
 <area shape="rect" id="node4" href="#open_gopro.communicator_interface.Message" target="_top" title="Base class for all messages that will be contained in a Messages class" alt="" coords="19,152,99,177"/>
-<area shape="rect" id="node2" title="Abstract base class for generic types." alt="" coords="138,79,210,104"/>
+<area shape="rect" id="node2" href="https://docs.python.org/3/library/typing.html#typing.Generic" target="_top" title="Abstract base class for generic types." alt="" coords="138,79,210,104"/>
 <area shape="rect" id="node5" href="#open_gopro.api.builders.HttpSetting" target="_top" title="An individual camera setting that is interacted with via Wifi." alt="" coords="69,5,165,31"/>
 <area shape="rect" id="node3" href="#open_gopro.communicator_interface.HttpMessage" target="_top" title="The base class for all HTTP messages. Stores common information." alt="" coords="5,79,113,104"/>
 </map>

python_sdk/_images/inheritance-5a64f3b42883ec3c7a991e32e9e83af0e5c9a522.png.map → python_sdk/_images/inheritance-6c1e795947f9c1272c8f486454575766c74fc592.png.map

@@ -1,4 +1,4 @@
 <map id="inheritance015dfdbf00" name="inheritance015dfdbf00">
 <area shape="rect" id="node1" href="#open_gopro.api.builders.BleSettingFacade" target="_top" title="Wrapper around BleSetting since a BleSetting&#39;s message definition changes based on how it is being operated on." alt="" coords="5,5,140,31"/>
-<area shape="rect" id="node2" title="Abstract base class for generic types." alt="" coords="37,79,109,104"/>
+<area shape="rect" id="node2" href="https://docs.python.org/3/library/typing.html#typing.Generic" target="_top" title="Abstract base class for generic types." alt="" coords="37,79,109,104"/>
 </map>

python_sdk/_images/inheritance-d8546d3def109014f1418034afe6f5ae469f81b2.png.map → python_sdk/_images/inheritance-97b59ee009da078936046bc9e738d14b38cde4e1.png.map

@@ -1,9 +1,9 @@
 <map id="inheritance61a0866e97" name="inheritance61a0866e97">
-<area shape="rect" id="node1" title="Helper class that provides a standard way to create an ABC using" alt="" coords="103,372,175,397"/>
+<area shape="rect" id="node1" href="https://docs.python.org/3/library/abc.html#abc.ABC" target="_top" title="Helper class that provides a standard way to create an ABC using" alt="" coords="103,372,175,397"/>
 <area shape="rect" id="node2" href="#open_gopro.communicator_interface.BaseGoProCommunicator" target="_top" title="Common Communicator interface" alt="" coords="44,299,233,324"/>
 <area shape="rect" id="node5" href="#open_gopro.communicator_interface.GoProHttp" target="_top" title="Interface definition for all HTTP communicators" alt="" coords="185,225,274,251"/>
 <area shape="rect" id="node6" href="#open_gopro.communicator_interface.GoProBle" target="_top" title="GoPro specific BLE Client" alt="" coords="5,152,88,177"/>
-<area shape="rect" id="node3" title="Abstract base class for generic types." alt="" coords="88,225,160,251"/>
+<area shape="rect" id="node3" href="https://docs.python.org/3/library/typing.html#typing.Generic" target="_top" title="Abstract base class for generic types." alt="" coords="88,225,160,251"/>
 <area shape="rect" id="node4" href="#open_gopro.gopro_base.GoProBase" target="_top" title="The base class for communicating with all GoPro Clients" alt="" coords="163,152,256,177"/>
 <area shape="rect" id="node8" href="#open_gopro.communicator_interface.GoProWirelessInterface" target="_top" title="The top&#45;level interface for a Wireless Open GoPro controller" alt="" coords="17,79,191,104"/>
 <area shape="rect" id="node9" href="#open_gopro.gopro_wireless.WirelessGoPro" target="_top" title="The top&#45;level BLE and Wifi interface to a Wireless GoPro device." alt="" coords="108,5,225,31"/>

python_sdk/_images/inheritance-e1592119d3000c7c19d7ad1c22deefbcce6ad0e2.png.map → python_sdk/_images/inheritance-b83b0d680310f026e7172be6cbd1251de5d8ad21.png.map

@@ -1,9 +1,9 @@
 <map id="inheritancece88257e1f" name="inheritancece88257e1f">
-<area shape="rect" id="node1" title="Helper class that provides a standard way to create an ABC using" alt="" coords="103,299,175,324"/>
+<area shape="rect" id="node1" href="https://docs.python.org/3/library/abc.html#abc.ABC" target="_top" title="Helper class that provides a standard way to create an ABC using" alt="" coords="103,299,175,324"/>
 <area shape="rect" id="node2" href="#open_gopro.communicator_interface.BaseGoProCommunicator" target="_top" title="Common Communicator interface" alt="" coords="45,225,234,251"/>
 <area shape="rect" id="node5" href="#open_gopro.communicator_interface.GoProHttp" target="_top" title="Interface definition for all HTTP communicators" alt="" coords="5,152,95,177"/>
 <area shape="rect" id="node6" href="#open_gopro.communicator_interface.GoProWiredInterface" target="_top" title="The top&#45;level interface for a Wired Open GoPro controller" alt="" coords="150,79,307,104"/>
-<area shape="rect" id="node3" title="Abstract base class for generic types." alt="" coords="119,152,191,177"/>
+<area shape="rect" id="node3" href="https://docs.python.org/3/library/typing.html#typing.Generic" target="_top" title="Abstract base class for generic types." alt="" coords="119,152,191,177"/>
 <area shape="rect" id="node4" href="#open_gopro.gopro_base.GoProBase" target="_top" title="The base class for communicating with all GoPro Clients" alt="" coords="33,79,126,104"/>
 <area shape="rect" id="node7" href="#open_gopro.gopro_wired.WiredGoPro" target="_top" title="The top&#45;level USB interface to a Wired GoPro device." alt="" coords="105,5,203,31"/>
 </map>

python_sdk/_images/inheritance-9e7418576ad1c01c1baac7156ce2480e33be0963.png.map → python_sdk/_images/inheritance-ca0c1e4872b9d585e582f1e9e1e477311b1ec2c5.png.map

@@ -1,4 +1,4 @@
 <map id="inheritancee72a61fe19" name="inheritancee72a61fe19">
 <area shape="rect" id="node1" href="#open_gopro.api.builders.BleStatusFacade" target="_top" title="Wrapper around BleStatus since a BleStatus&#39;s message definition changes based on how it is being operated on." alt="" coords="5,5,135,31"/>
-<area shape="rect" id="node2" title="Abstract base class for generic types." alt="" coords="34,79,106,104"/>
+<area shape="rect" id="node2" href="https://docs.python.org/3/library/typing.html#typing.Generic" target="_top" title="Abstract base class for generic types." alt="" coords="34,79,106,104"/>
 </map>

python_sdk/_sources/api.rst.txt

@@ -76,6 +76,8 @@ These should not be imported directly and instead should be accessed using the r
 Base Types
 ----------
 
+.. automodule:: open_gopro.types
+
 GoPro Enum
 ^^^^^^^^^^
 
@@ -173,6 +175,8 @@ These are the various models that are returned in responses, used in commands, e
 
    from open_gopro.models import ***
 
+.. autopydantic_model:: open_gopro.models.media_list.MediaPath
+
 .. autopydantic_model:: open_gopro.models.media_list.MediaMetadata
 
 .. autopydantic_model:: open_gopro.models.media_list.PhotoMetadata
@@ -221,6 +225,8 @@ Exceptions
 Common Interface
 ================
 
+.. automodule:: open_gopro.parser_interface
+
 .. autoclass:: open_gopro.gopro_base.GoProBase
 
 .. autoclass:: open_gopro.communicator_interface.GoProBle

python_sdk/_static/_sphinx_javascript_frameworks_compat.js

@@ -1,20 +1,9 @@
-/*
- * _sphinx_javascript_frameworks_compat.js
- * ~~~~~~~~~~
- *
- * Compatability shim for jQuery and underscores.js.
- *
- * WILL BE REMOVED IN Sphinx 6.0
- * xref RemovedInSphinx60Warning
+/* Compatability shim for jQuery and underscores.js.
  *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
  */
 
-/**
- * select a different prefix for underscore
- */
-$u = _.noConflict();
-
-
 /**
  * small helper function to urldecode strings
  *

python_sdk/_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -237,6 +237,10 @@ a.headerlink {
     visibility: hidden;
 }
 
+a:visited {
+    color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -324,13 +328,15 @@ aside.sidebar {
 p.sidebar-title {
     font-weight: bold;
 }
+
 nav.contents,
 aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
+
 nav.contents,
 aside.topic,
 div.topic {
@@ -606,6 +612,7 @@ ol.simple p,
 ul.simple p {
     margin-bottom: 0;
 }
+
 aside.footnote > span,
 div.citation > span {
     float: left;
@@ -667,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -735,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

python_sdk/_static/doctools.js

@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

python_sdk/_static/documentation_options.js

@@ -1,5 +1,4 @@
-var DOCUMENTATION_OPTIONS = {
-    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+const DOCUMENTATION_OPTIONS = {
     VERSION: '',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,

python_sdk/_static/graphviz.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- graphviz extension.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */