Merge pull request #566 from Yubico/python-yubihsm-3.0

Update python-yubihsm docs for 3.0.0.
Yubico · Dec 7, 2023 · 2eb4652 · 2eb4652
2 parents 93d7c39 + e76227a
commit 2eb4652
Show file tree

Hide file tree

Showing 75 changed files with 6,363 additions and 20,324 deletions.
diff --git a/content/YubiHSM2/Component_Reference/python-yubihsm/index.adoc b/content/YubiHSM2/Component_Reference/python-yubihsm/index.adoc
@@ -1,7 +1,7 @@
 == Python Library
 
 The link:/python-yubihsm/[Python library] allows you to interface with a YubiHSM 2 through
-the Connector service using the Python programming language. It supports both Python 2 and 3.
+the Connector service using the Python programming language. It supports Python 3.8 or later.
 
 The recommended way to install the library is by using `pip` inside a
 `virtualenv`. To create and activate a virtualenv, just run:

diff --git a/static/python-yubihsm/API_Documentation/.buildinfo b/static/python-yubihsm/API_Documentation/.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: 6fcbddf7fafece9a62cb109f982bd6cb
+config: cabc3d5c58308cf308a4e81f0af7a52a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/static/python-yubihsm/API_Documentation/_modules/index.html b/static/python-yubihsm/API_Documentation/_modules/index.html
@@ -1,206 +1,109 @@
-
-
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
   <meta charset="utf-8" />
-
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-
-  <title>Overview: module code &mdash; python-yubihsm 2.1.0 documentation</title>
-
-
-
-  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
-  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-
-
-
+  <title>Overview: module code &mdash; python-yubihsm 3.0.0.dev0 documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
-
-
-
-
-
-
-
-
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-
-      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
-        <script src="../_static/jquery.js"></script>
-        <script src="../_static/underscore.js"></script>
-        <script src="../_static/doctools.js"></script>
-
-    <script type="text/javascript" src="../_static/js/theme.js"></script>
-
-
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=3aa38957"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" /> 
 </head>
 
-<body class="wy-body-for-nav">
-
-
+<body class="wy-body-for-nav"> 
   <div class="wy-grid-for-nav">
-
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
-
 
 
-            <a href="../index.html" class="icon icon-home"> python-yubihsm
-
-
 
+          <a href="../index.html" class="icon icon-home">
+            python-yubihsm
           </a>
-
-
-
-
               <div class="version">
-                2.1
+                3.0
               </div>
-
-
-
-
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
-    <input type="text" name="q" placeholder="Search docs" />
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>
-
-
-        </div>
-
-
-        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
-
-
-
-
-
-
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <!-- Local TOC -->
               <div class="local-toc"></div>
-
-
         </div>
-
       </div>
     </nav>
 
-    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
-
-
-      <nav class="wy-nav-top" aria-label="top navigation">
-
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="../index.html">python-yubihsm</a>
-
       </nav>
 
-
       <div class="wy-nav-content">
-
         <div class="rst-content">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<div role="navigation" aria-label="breadcrumbs navigation">
-
+          <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-
-      <li>Overview: module code</li>
-
-
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
       <li class="wy-breadcrumbs-aside">
-
       </li>
-
   </ul>
-
-
   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-
+             
   <h1>All modules for which code is available</h1>
-<ul><li><a href="yubihsm/core.html">yubihsm.core</a></li>
+<ul><li><a href="yubihsm/backends.html">yubihsm.backends</a></li>
+<ul><li><a href="yubihsm/backends/http.html">yubihsm.backends.http</a></li>
+<li><a href="yubihsm/backends/usb.html">yubihsm.backends.usb</a></li>
+</ul><li><a href="yubihsm/core.html">yubihsm.core</a></li>
 <li><a href="yubihsm/defs.html">yubihsm.defs</a></li>
-<li><a href="yubihsm/eddsa.html">yubihsm.eddsa</a></li>
 <li><a href="yubihsm/exceptions.html">yubihsm.exceptions</a></li>
 <li><a href="yubihsm/objects.html">yubihsm.objects</a></li>
 <li><a href="yubihsm/utils.html">yubihsm.utils</a></li>
 </ul>
 
            </div>
-
           </div>
           <footer>
 
   <hr/>
 
   <div role="contentinfo">
-    <p>
-        &#169; Copyright 2018, Yubico.
-
-    </p>
+    <p>&#169; Copyright 2018, Yubico.</p>
   </div>
-
-
-
-    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
-
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
-
-    provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
 
 </footer>
         </div>
       </div>
-
     </section>
-
   </div>
-
-
-  <script type="text/javascript">
+  <script>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
-
-
-
-
-
+  </script> 
 
 </body>
 </html>