Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Sep 8, 2023
1 parent 0b19e32 commit 81cb02d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions _autosummary/one.remote.globus.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h2>Setup<a class="headerlink" href="#setup" title="Link to this heading"></a
(i.e. when switching between different Globus client IDs).</p>
<p>In order to use this function you need:</p>
<ol class="arabic simple">
<li><p>The client ID of an existing Globus Client (<a href="#id6"><span class="problematic" id="id7">`see this tutorial`_</span></a>).</p></li>
<li><p>The client ID of an existing Globus Client (<a class="reference external" href="https://globus-sdk-python.readthedocs.io/en/stable/tutorial.html">see this tutorial</a>).</p></li>
<li><p>Set up <a class="reference external" href="https://www.globus.org/globus-connect-personal">Global Connect</a> on your local device.</p></li>
<li><p>Register your local device as an <a class="reference external" href="https://app.globus.org/">endpoint</a> in your Globus Client.</p></li>
</ol>
Expand Down Expand Up @@ -382,7 +382,7 @@ <h2>Setup<a class="headerlink" href="#setup" title="Link to this heading"></a
<dd><p>Setup a Globus client.</p>
<p>In order to use this function you need:</p>
<ol class="arabic simple">
<li><p>The client ID of an existing Globus Client (<a href="#id8"><span class="problematic" id="id9">`see this tutorial`_</span></a>).</p></li>
<li><p>The client ID of an existing Globus Client (<a class="reference external" href="https://globus-sdk-python.readthedocs.io/en/stable/tutorial.html">see this tutorial</a>).</p></li>
<li><p>Set up <a class="reference external" href="https://www.globus.org/globus-connect-personal">Global Connect</a> on your local device.</p></li>
<li><p>Register your local device as an <a class="reference external" href="https://app.globus.org/">endpoint</a> in your Globus Client.</p></li>
</ol>
Expand Down
12 changes: 6 additions & 6 deletions _modules/one/remote/globus.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
<div itemprop="articleBody">

<h1>Source code for one.remote.globus</h1><div class="highlight"><pre>
<span></span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;A module for handling file operations through the Globus SDK.</span>
<span></span><span class="sd">&quot;&quot;&quot;A module for handling file operations through the Globus SDK.</span>

<span class="sd">Setup</span>
<span class="sd">-----</span>
Expand All @@ -115,7 +115,7 @@ <h1>Source code for one.remote.globus</h1><div class="highlight"><pre>

<span class="sd">In order to use this function you need:</span>

<span class="sd">1. The client ID of an existing Globus Client (\ `see this tutorial`_).</span>
<span class="sd">1. The client ID of an existing Globus Client (`see this tutorial`_).</span>
<span class="sd">2. Set up `Global Connect`_ on your local device.</span>
<span class="sd">3. Register your local device as an `endpoint`_ in your Globus Client.</span>

Expand All @@ -135,7 +135,7 @@ <h1>Source code for one.remote.globus</h1><div class="highlight"><pre>
<span class="sd">&gt;&gt;&gt; print(globus.endpoints.keys())</span>
<span class="sd">&gt;&gt;&gt; print(globus.endpoints[&#39;local&#39;])</span>

<span class="sd">.. _how to create one: https://globus-sdk-python.readthedocs.io/en/stable/tutorial.html</span>
<span class="sd">.. _see this tutorial: https://globus-sdk-python.readthedocs.io/en/stable/tutorial.html</span>
<span class="sd">.. _Global Connect: https://www.globus.org/globus-connect-personal</span>
<span class="sd">.. _endpoint: https://app.globus.org/</span>

Expand Down Expand Up @@ -840,16 +840,16 @@ <h1>Source code for one.remote.globus</h1><div class="highlight"><pre>
<a class="viewcode-back" href="../../../_autosummary/one.remote.globus.html#one.remote.globus.Globus.setup">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="n">client_name</span><span class="o">=</span><span class="s1">&#39;default&#39;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Setup a Globus client.</span>

<span class="sd"> In order to use this function you need:</span>

<span class="sd"> 1. The client ID of an existing Globus Client (\ `see this tutorial`_).</span>
<span class="sd"> 1. The client ID of an existing Globus Client (`see this tutorial`_).</span>
<span class="sd"> 2. Set up `Global Connect`_ on your local device.</span>
<span class="sd"> 3. Register your local device as an `endpoint`_ in your Globus Client.</span>

<span class="sd"> .. _how to create one: https://globus-sdk-python.readthedocs.io/en/stable/tutorial.html</span>
<span class="sd"> .. _see this tutorial: https://globus-sdk-python.readthedocs.io/en/stable/tutorial.html</span>
<span class="sd"> .. _Global Connect: https://www.globus.org/globus-connect-personal</span>
<span class="sd"> .. _endpoint: https://app.globus.org/</span>

Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 81cb02d

Please sign in to comment.