Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sckott
sckott committed Oct 19, 2016
1 parent 2dc3c1b commit 45463f0
Show file tree
Hide file tree
Showing 32 changed files with 258 additions and 174 deletions.
Binary file modified docs/_build/doctrees/changelog_link.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/occurrences.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/registry.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/species.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: 2a689e895ead89eed271b97632cf41a7
config: 5504abec919aa17205047f57d6d9587a
tags: 645f666f9bcd5a90fca523b33c5a78b7
8 changes: 4 additions & 4 deletions docs/_build/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Overview: module code &mdash; pygbif 0.1.6.0 documentation</title>
<title>Overview: module code &mdash; pygbif 0.2.0 documentation</title>



Expand All @@ -33,7 +33,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="pygbif 0.1.6.0 documentation" href="../index.html"/>
<link rel="top" title="pygbif 0.2.0 documentation" href="../index.html"/>


<script src="../_static/js/modernizr.min.js"></script>
Expand Down Expand Up @@ -61,7 +61,7 @@


<div class="version">
0.1.6.0
0.2.0
</div>


Expand Down Expand Up @@ -178,7 +178,7 @@ <h1>All modules for which code is available</h1>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.1.6.0',
VERSION:'0.2.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
8 changes: 4 additions & 4 deletions docs/_build/html/_modules/pygbif/occurrences/count.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>pygbif.occurrences.count &mdash; pygbif 0.1.6.0 documentation</title>
<title>pygbif.occurrences.count &mdash; pygbif 0.2.0 documentation</title>



Expand All @@ -33,7 +33,7 @@
<link rel="index" title="Index"
href="../../../genindex.html"/>
<link rel="search" title="Search" href="../../../search.html"/>
<link rel="top" title="pygbif 0.1.6.0 documentation" href="../../../index.html"/>
<link rel="top" title="pygbif 0.2.0 documentation" href="../../../index.html"/>
<link rel="up" title="Module code" href="../../index.html"/>


Expand Down Expand Up @@ -62,7 +62,7 @@


<div class="version">
0.1.6.0
0.2.0
</div>


Expand Down Expand Up @@ -299,7 +299,7 @@ <h1>Source code for pygbif.occurrences.count</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'0.1.6.0',
VERSION:'0.2.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
16 changes: 8 additions & 8 deletions docs/_build/html/_modules/pygbif/occurrences/download.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>pygbif.occurrences.download &mdash; pygbif 0.1.6.0 documentation</title>
<title>pygbif.occurrences.download &mdash; pygbif 0.2.0 documentation</title>



Expand All @@ -33,7 +33,7 @@
<link rel="index" title="Index"
href="../../../genindex.html"/>
<link rel="search" title="Search" href="../../../search.html"/>
<link rel="top" title="pygbif 0.1.6.0 documentation" href="../../../index.html"/>
<link rel="top" title="pygbif 0.2.0 documentation" href="../../../index.html"/>
<link rel="up" title="Module code" href="../../index.html"/>


Expand Down Expand Up @@ -62,7 +62,7 @@


<div class="version">
0.1.6.0
0.2.0
</div>


Expand Down Expand Up @@ -458,28 +458,28 @@ <h1>Source code for pygbif.occurrences.download</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">gbif_GET</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="p">{},</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>


<span class="k">def</span> <span class="nf">download_list</span><span class="p">(</span><span class="n">user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">pwd</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">download_list</span><span class="p">(</span><span class="n">user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">pwd</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Lists the downloads created by a user.</span>

<span class="sd"> :param user: [str] A user name, look at env var ``GBIF_USER`` first</span>
<span class="sd"> :param pwd: [str] Your password, look at env var ``GBIF_PWD`` first</span>
<span class="sd"> :param limit: [int] Number of records to return. Default: ``20``</span>
<span class="sd"> :param start: [int] Record number to start at. Default: ``0``</span>
<span class="sd"> :param offset: [int] Record number to start at. Default: ``0``</span>

<span class="sd"> Usage::</span>

<span class="sd"> from pygbif import occurrences as occ</span>
<span class="sd"> occ.download_list(user = &quot;sckott&quot;)</span>
<span class="sd"> occ.download_list(user = &quot;sckott&quot;, limit = 5)</span>
<span class="sd"> occ.download_list(user = &quot;sckott&quot;, start = 21)</span>
<span class="sd"> occ.download_list(user = &quot;sckott&quot;, offset = 21)</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">user</span> <span class="o">=</span> <span class="n">_check_environ</span><span class="p">(</span><span class="s1">&#39;GBIF_USER&#39;</span><span class="p">,</span> <span class="n">user</span><span class="p">)</span>
<span class="n">pwd</span> <span class="o">=</span> <span class="n">_check_environ</span><span class="p">(</span><span class="s1">&#39;GBIF_PWD&#39;</span><span class="p">,</span> <span class="n">pwd</span><span class="p">)</span>

<span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;http://api.gbif.org/v1/occurrence/download/user/&#39;</span> <span class="o">+</span> <span class="n">user</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span> <span class="s1">&#39;offset&#39;</span><span class="p">:</span> <span class="n">start</span><span class="p">}</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span> <span class="s1">&#39;offset&#39;</span><span class="p">:</span> <span class="n">offset</span><span class="p">}</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">gbif_GET</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="p">(</span><span class="n">user</span><span class="p">,</span> <span class="n">pwd</span><span class="p">))</span>
<span class="k">return</span> <span class="p">{</span><span class="s1">&#39;meta&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;offset&#39;</span><span class="p">:</span> <span class="n">res</span><span class="p">[</span><span class="s1">&#39;offset&#39;</span><span class="p">],</span>
<span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="n">res</span><span class="p">[</span><span class="s1">&#39;limit&#39;</span><span class="p">],</span>
Expand Down Expand Up @@ -589,7 +589,7 @@ <h1>Source code for pygbif.occurrences.download</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'0.1.6.0',
VERSION:'0.2.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
8 changes: 4 additions & 4 deletions docs/_build/html/_modules/pygbif/occurrences/get.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>pygbif.occurrences.get &mdash; pygbif 0.1.6.0 documentation</title>
<title>pygbif.occurrences.get &mdash; pygbif 0.2.0 documentation</title>



Expand All @@ -33,7 +33,7 @@
<link rel="index" title="Index"
href="../../../genindex.html"/>
<link rel="search" title="Search" href="../../../search.html"/>
<link rel="top" title="pygbif 0.1.6.0 documentation" href="../../../index.html"/>
<link rel="top" title="pygbif 0.2.0 documentation" href="../../../index.html"/>
<link rel="up" title="Module code" href="../../index.html"/>


Expand Down Expand Up @@ -62,7 +62,7 @@


<div class="version">
0.1.6.0
0.2.0
</div>


Expand Down Expand Up @@ -227,7 +227,7 @@ <h1>Source code for pygbif.occurrences.get</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'0.1.6.0',
VERSION:'0.2.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
10 changes: 5 additions & 5 deletions docs/_build/html/_modules/pygbif/occurrences/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>pygbif.occurrences.search &mdash; pygbif 0.1.6.0 documentation</title>
<title>pygbif.occurrences.search &mdash; pygbif 0.2.0 documentation</title>



Expand All @@ -33,7 +33,7 @@
<link rel="index" title="Index"
href="../../../genindex.html"/>
<link rel="search" title="Search" href="../../../search.html"/>
<link rel="top" title="pygbif 0.1.6.0 documentation" href="../../../index.html"/>
<link rel="top" title="pygbif 0.2.0 documentation" href="../../../index.html"/>
<link rel="up" title="Module code" href="../../index.html"/>


Expand Down Expand Up @@ -62,7 +62,7 @@


<div class="version">
0.1.6.0
0.2.0
</div>


Expand Down Expand Up @@ -262,7 +262,7 @@ <h1>Source code for pygbif.occurrences.search</h1><div class="highlight"><pre>
<span class="sd"> occurrences.search(catalogNumber=&quot;49366&quot;, limit=20)</span>
<span class="sd"> # occurrences.search(catalogNumber=[&quot;49366&quot;,&quot;Bird.27847588&quot;], limit=20)</span>

<span class="sd"> # Use paging parameters (limit and start) to page. Note the different results</span>
<span class="sd"> # Use paging parameters (limit and offset) to page. Note the different results</span>
<span class="sd"> # for the two queries below.</span>
<span class="sd"> occurrences.search(datasetKey=&#39;7b5d6a48-f762-11e1-a439-00145eb45e9a&#39;, offset=10, limit=5)</span>
<span class="sd"> occurrences.search(datasetKey=&#39;7b5d6a48-f762-11e1-a439-00145eb45e9a&#39;, offset=20, limit=5)</span>
Expand Down Expand Up @@ -499,7 +499,7 @@ <h1>Source code for pygbif.occurrences.search</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'0.1.6.0',
VERSION:'0.2.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
8 changes: 4 additions & 4 deletions docs/_build/html/_modules/pygbif/registry/datasets.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>pygbif.registry.datasets &mdash; pygbif 0.1.6.0 documentation</title>
<title>pygbif.registry.datasets &mdash; pygbif 0.2.0 documentation</title>



Expand All @@ -33,7 +33,7 @@
<link rel="index" title="Index"
href="../../../genindex.html"/>
<link rel="search" title="Search" href="../../../search.html"/>
<link rel="top" title="pygbif 0.1.6.0 documentation" href="../../../index.html"/>
<link rel="top" title="pygbif 0.2.0 documentation" href="../../../index.html"/>
<link rel="up" title="Module code" href="../../index.html"/>


Expand Down Expand Up @@ -62,7 +62,7 @@


<div class="version">
0.1.6.0
0.2.0
</div>


Expand Down Expand Up @@ -424,7 +424,7 @@ <h1>Source code for pygbif.registry.datasets</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'0.1.6.0',
VERSION:'0.2.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down

0 comments on commit 45463f0

Please sign in to comment.