fix #25 overhaul to docs, change how they are displayed

more better interface

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2015 Scott Chamberlain
+Copyright (C) 2017 Scott Chamberlain
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

docs/_build/html/.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: 5504abec919aa17205047f57d6d9587a
+config: 2b048d99da42765477a71baf719a2543
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_modules/index.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; pygbif 0.2.0 documentation</title>
+  <title>Overview: module code &mdash; pygbif 0.2.1 documentation</title>
 
 
 
@@ -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.2.0 documentation" href="../index.html"/> 
+    <link rel="top" title="pygbif 0.2.1 documentation" href="../index.html"/> 
 
 
   <script src="../_static/js/modernizr.min.js"></script>
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                0.2.0
+                0.2.1
               </div>
 
 
@@ -82,11 +82,29 @@
 
 
 
-                <ul>
-<li class="toctree-l1"><a class="reference internal" href="../occurrences.html">occurrences module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../registry.html">registry module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../species.html">species module</a></li>
+                <p class="caption"><span class="caption-text">Installation</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../intro/install.html">Installation guide</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Docs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../docs/faq.html">Frequently Asked Questions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../docs/usecases.html">Usecases</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Modules</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../modules/intro.html">pygbif modules</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../modules/occurrence.html">occurrence module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../modules/registry.html">registry module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../modules/species.html">species module</a></li>
+</ul>
+<p class="caption"><span class="caption-text">All the rest</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="../changelog_link.html">Changelog</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributors.html">Contributors</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../conduct.html">Contributor Code of Conduct</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../license.html">LICENSE</a></li>
 </ul>
 
 
@@ -144,7 +162,6 @@ <h1>All modules for which code is available</h1>
 <li><a href="pygbif/species/name_parser.html">pygbif.species.name_parser</a></li>
 <li><a href="pygbif/species/name_suggest.html">pygbif.species.name_suggest</a></li>
 <li><a href="pygbif/species/name_usage.html">pygbif.species.name_usage</a></li>
-<li><a href="pygbif/species/names.html">pygbif.species.names</a></li>
 </ul>
 
            </div>
@@ -178,7 +195,7 @@ <h1>All modules for which code is available</h1>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../',
-            VERSION:'0.2.0',
+            VERSION:'0.2.1',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

docs/_build/html/_modules/pygbif/occurrences/count.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pygbif.occurrences.count &mdash; pygbif 0.2.0 documentation</title>
+  <title>pygbif.occurrences.count &mdash; pygbif 0.2.1 documentation</title>
 
 
 
@@ -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.2.0 documentation" href="../../../index.html"/>
+    <link rel="top" title="pygbif 0.2.1 documentation" href="../../../index.html"/>
         <link rel="up" title="Module code" href="../../index.html"/> 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                0.2.0
+                0.2.1
               </div>
 
 
@@ -83,11 +83,29 @@
 
 
 
-                <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../occurrences.html">occurrences module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../registry.html">registry module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../species.html">species module</a></li>
+                <p class="caption"><span class="caption-text">Installation</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../intro/install.html">Installation guide</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Docs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../docs/faq.html">Frequently Asked Questions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../docs/usecases.html">Usecases</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Modules</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/intro.html">pygbif modules</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/occurrence.html">occurrence module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/registry.html">registry module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/species.html">species module</a></li>
+</ul>
+<p class="caption"><span class="caption-text">All the rest</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../changelog_link.html">Changelog</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../contributors.html">Contributors</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../conduct.html">Contributor Code of Conduct</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../license.html">LICENSE</a></li>
 </ul>
 
 
@@ -299,7 +317,7 @@ <h1>Source code for pygbif.occurrences.count</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../',
-            VERSION:'0.2.0',
+            VERSION:'0.2.1',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

docs/_build/html/_modules/pygbif/occurrences/download.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pygbif.occurrences.download &mdash; pygbif 0.2.0 documentation</title>
+  <title>pygbif.occurrences.download &mdash; pygbif 0.2.1 documentation</title>
 
 
 
@@ -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.2.0 documentation" href="../../../index.html"/>
+    <link rel="top" title="pygbif 0.2.1 documentation" href="../../../index.html"/>
         <link rel="up" title="Module code" href="../../index.html"/> 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                0.2.0
+                0.2.1
               </div>
 
 
@@ -83,11 +83,29 @@
 
 
 
-                <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../occurrences.html">occurrences module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../registry.html">registry module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../species.html">species module</a></li>
+                <p class="caption"><span class="caption-text">Installation</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../intro/install.html">Installation guide</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Docs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../docs/faq.html">Frequently Asked Questions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../docs/usecases.html">Usecases</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Modules</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/intro.html">pygbif modules</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/occurrence.html">occurrence module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/registry.html">registry module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/species.html">species module</a></li>
+</ul>
+<p class="caption"><span class="caption-text">All the rest</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../changelog_link.html">Changelog</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../contributors.html">Contributors</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../conduct.html">Contributor Code of Conduct</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../license.html">LICENSE</a></li>
 </ul>
 
 
@@ -222,6 +240,11 @@ <h1>Source code for pygbif.occurrences.download</h1><div class="highlight"><pre>
 <span class="sd">    for more info, and the predicates docs</span>
 <span class="sd">    http://www.gbif.org/developer/occurrence#predicates</span>
 
+<span class="sd">    GBIF has a limit of 12,000 characters for download queries - so</span>
+<span class="sd">    if you&#39;re download request is really, really long and complex,</span>
+<span class="sd">    consider breaking it up into multiple requests by one factor or</span>
+<span class="sd">    another.</span>
+
 <span class="sd">    :return: A dictionary, of results</span>
 
 <span class="sd">    Usage::</span>
@@ -494,7 +517,7 @@ <h1>Source code for pygbif.occurrences.download</h1><div class="highlight"><pre>
 
 <span class="sd">    :param key: [str] A key generated from a request, like that from ``download``</span>
 <span class="sd">    :param path: [str] Path to write zip file to. Default: ``&quot;.&quot;``, with a ``.zip`` appended to the end.</span>
-<span class="sd">    :param **kwargs: Further named arguments passed on to ``requests.get``</span>
+<span class="sd">    :param **kwargs**: Further named arguments passed on to ``requests.get``</span>
 
 <span class="sd">    Downloads the zip file to a directory you specify on your machine.</span>
 <span class="sd">    The speed of this function is of course proportional to the size of the</span>
@@ -589,7 +612,7 @@ <h1>Source code for pygbif.occurrences.download</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../',
-            VERSION:'0.2.0',
+            VERSION:'0.2.1',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

docs/_build/html/_modules/pygbif/occurrences/get.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pygbif.occurrences.get &mdash; pygbif 0.2.0 documentation</title>
+  <title>pygbif.occurrences.get &mdash; pygbif 0.2.1 documentation</title>
 
 
 
@@ -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.2.0 documentation" href="../../../index.html"/>
+    <link rel="top" title="pygbif 0.2.1 documentation" href="../../../index.html"/>
         <link rel="up" title="Module code" href="../../index.html"/> 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                0.2.0
+                0.2.1
               </div>
 
 
@@ -83,11 +83,29 @@
 
 
 
-                <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../occurrences.html">occurrences module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../registry.html">registry module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../species.html">species module</a></li>
+                <p class="caption"><span class="caption-text">Installation</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../intro/install.html">Installation guide</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Docs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../docs/faq.html">Frequently Asked Questions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../docs/usecases.html">Usecases</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Modules</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/intro.html">pygbif modules</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/occurrence.html">occurrence module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/registry.html">registry module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules/species.html">species module</a></li>
+</ul>
+<p class="caption"><span class="caption-text">All the rest</span></p>
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../changelog_link.html">Changelog</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../contributors.html">Contributors</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../conduct.html">Contributor Code of Conduct</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../license.html">LICENSE</a></li>
 </ul>
 
 
@@ -227,7 +245,7 @@ <h1>Source code for pygbif.occurrences.get</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../',
-            VERSION:'0.2.0',
+            VERSION:'0.2.1',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true