Skip to content

Commit

Permalink
Release v1.5.2
Browse files Browse the repository at this point in the history
Update docstrings and return instance_info
Copy static.css to docs dir only if available
  • Loading branch information
dormant-user committed Sep 28, 2023
1 parent b6c43da commit 5ced9e0
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 27 deletions.
25 changes: 12 additions & 13 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ <h1>Welcome to VPN Server’s documentation!<a class="headerlink" href="#welcome
<dl class="py method">
<dt class="sig sig-object py" id="vpn.main.VPNServer._create_key_pair">
<span class="sig-name descname"><span class="pre">_create_key_pair</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#vpn.main.VPNServer._create_key_pair" title="Permalink to this definition"></a></dt>
<dd><p>Creates a <code class="docutils literal notranslate"><span class="pre">KeyPair</span></code> of type <code class="docutils literal notranslate"><span class="pre">RSA</span></code> stored as a <code class="docutils literal notranslate"><span class="pre">PEM</span></code> file to use with <code class="docutils literal notranslate"><span class="pre">OpenSSH</span></code>.</p>
<dd><p>Creates a <code class="docutils literal notranslate"><span class="pre">KeyPair</span></code> of type <code class="docutils literal notranslate"><span class="pre">RSA</span></code> stores as a <code class="docutils literal notranslate"><span class="pre">PEM</span></code> file for SSH connection.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Flag to indicate the calling function, if a <code class="docutils literal notranslate"><span class="pre">KeyPair</span></code> was created successfully.</p>
Expand Down Expand Up @@ -358,17 +358,16 @@ <h1>Welcome to VPN Server’s documentation!<a class="headerlink" href="#welcome

<dl class="py method">
<dt class="sig sig-object py" id="vpn.main.VPNServer.create_vpn_server">
<span class="sig-name descname"><span class="pre">create_vpn_server</span></span><span class="sig-paren">(</span><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="#vpn.main.VPNServer.create_vpn_server" title="Permalink to this definition"></a></dt>
<dd><p>Calls the class methods <code class="docutils literal notranslate"><span class="pre">_create_ec2_instance</span></code> and <code class="docutils literal notranslate"><span class="pre">_instance_info</span></code> to configure the VPN server.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p>Checks if info and pem files are present, before spinning up a new instance.</p></li>
<li><p>If present, checks the connection to the existing origin and tears down the instance if connection fails.</p></li>
<li><p>If connects, notifies user with details and adds key-value pair <code class="docutils literal notranslate"><span class="pre">Retry:</span> <span class="pre">True</span></code> to info file.</p></li>
<li><p>If another request is sent to start the vpn, creates a new instance regardless of existing info.</p></li>
</ul>
</div>
<span class="sig-name descname"><span class="pre">create_vpn_server</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#vpn.main.VPNServer.create_vpn_server" title="Permalink to this definition"></a></dt>
<dd><p>Creates an OpenVPN Access Server hosted on AWS ec2.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>VPN access server information.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>Dict[str, Union[str, int]] or None</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
Expand All @@ -386,7 +385,7 @@ <h1>Welcome to VPN Server’s documentation!<a class="headerlink" href="#welcome
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p>Doesn’t require any argument, as long as the JSON dump is neither removed nor modified by hand.</p>
<p>Doesn’t require any argument, as long as the JSON dump is neither removed nor modified manually.</p>
</div>
<p class="rubric">References</p>
<ul>
Expand Down
Loading

0 comments on commit 5ced9e0

Please sign in to comment.