Documentation update, resolves #71.

googlearchive · Aug 6, 2016 · 9eba497 · 9eba497
1 parent 984a17b
commit 9eba497
Show file tree

Hide file tree

Showing 48 changed files with 14,072 additions and 12,617 deletions.
diff --git a/README.rst b/README.rst
@@ -11,7 +11,7 @@ Project Info
 - Homepage: `https://pypi.python.org/pypi/PyDrive <https://pypi.python.org/pypi/PyDrive>`_                                                 
 - Documentation:
    - Version 1.0.0 (PyPI): `http://pythonhosted.org/PyDrive <http://pythonhosted.org/PyDrive>`_
-   - Version 1.1.2: `GitHub pages <https://googledrive.github.io/PyDrive/docs/_build/html/index.html>`_
+   - Version 1.2.1: `GitHub pages <https://googledrive.github.io/PyDrive/docs/_build/html/index.html>`_
 - Github: `https://github.com/googledrive/PyDrive <https://github.com/googledrive/PyDrive>`_
 
 Features of PyDrive
@@ -36,7 +36,7 @@ To install the most up-to-date version from GitHub, use:
 
 ::
 
-    $ pip install -e git+git@github.com:googledrive/PyDrive.git#egg=PyDrive
+    $  pip install git+https://github.com/googledrive/PyDrive.git#egg=PyDrive
 
 OAuth made easy
 ---------------

diff --git a/docs/README b/docs/README
@@ -1,7 +1,7 @@
 This document outlines how to rebuild the documentation.
 
 General setup:
-- Install Sphinx.
+- Install Sphinx, `pip install sphinx`
 - run `make html` in this folder, to update the documentation.
 
 If code files were added, the easiest way to reflect code changes in the

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/filelist.doctree b/docs/_build/doctrees/filelist.doctree
diff --git a/docs/_build/doctrees/filemanagement.doctree b/docs/_build/doctrees/filemanagement.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/oauth.doctree b/docs/_build/doctrees/oauth.doctree
diff --git a/docs/_build/doctrees/pydrive.doctree b/docs/_build/doctrees/pydrive.doctree
diff --git a/docs/_build/doctrees/quickstart.doctree b/docs/_build/doctrees/quickstart.doctree
diff --git a/docs/_build/html/.buildinfo b/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: beefd3390a0bf6b74bc80a333c861dfa
+config: ceeef8e4f27a464cf64df6bbe686aec7
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt
@@ -14,7 +14,7 @@ Project Info
 - Homepage: `https://pypi.python.org/pypi/PyDrive <https://pypi.python.org/pypi/PyDrive>`_
 - Documentation:
    - Version 1.0.0 (PyPI): `http://pythonhosted.org/PyDrive <http://pythonhosted.org/PyDrive>`_
-   - Version 1.1.2: `GitHub pages <https://googledrive.github.io/PyDrive/docs/_build/html/index.html>`_
+   - Version 1.2.1: `GitHub pages <https://googledrive.github.io/PyDrive/docs/_build/html/index.html>`_
 - Github: `https://github.com/googledrive/PyDrive <https://github.com/googledrive/PyDrive>`_
 
 How to install
@@ -30,7 +30,7 @@ To install the most up-to-date version from GitHub, use:
 
 ::
 
-    $ pip install -e git+git@github.com:googledrive/PyDrive.git#egg=PyDrive
+    $ pip install git+https://github.com/googledrive/PyDrive.git#egg=PyDrive
 
 Table of Contents
 =================

diff --git a/docs/_build/html/_static/alabaster.css b/docs/_build/html/_static/alabaster.css
@@ -15,19 +15,55 @@
 
 
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 @import url("basic.css");
 
 /* -- page layout ----------------------------------------------------------- */
 
 body {
     font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
     font-size: 17px;
-    background-color: white;
+    background-color: #fff;
     color: #000;
     margin: 0;
     padding: 0;
 }
 
+
 div.document {
     width: 940px;
     margin: 30px auto 0 auto;
@@ -44,14 +80,16 @@ div.bodywrapper {
 
 div.sphinxsidebar {
     width: 220px;
+    font-size: 14px;
+    line-height: 1.5;
 }
 
 hr {
     border: 1px solid #B1B4B6;
 }
 
 div.body {
-    background-color: #ffffff;
+    background-color: #fff;
     color: #3E4349;
     padding: 0 30px 0 30px;
 }
@@ -72,6 +110,11 @@ div.footer a {
     color: #888;
 }
 
+p.caption {
+    font-family: inherit;
+    font-size: inherit;
+}
+
 
 div.relations {
     display: none;
@@ -88,11 +131,6 @@ div.sphinxsidebar a:hover {
     border-bottom: 1px solid #999;
 }
 
-div.sphinxsidebar {
-    font-size: 14px;
-    line-height: 1.5;
-}
-
 div.sphinxsidebarwrapper {
     padding: 18px 10px;
 }
@@ -229,11 +267,12 @@ div.body p, div.body dd, div.body li {
 div.admonition {
     margin: 20px 0px;
     padding: 10px 30px;
-    background-color: #FCC;
-    border: 1px solid #FAA;
+    background-color: #EEE;
+    border: 1px solid #CCC;
 }
 
-div.admonition tt.xref, div.admonition a tt {
+div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
+    background-color: ;
     border-bottom: 1px solid #fafafa;
 }
 
@@ -256,25 +295,71 @@ div.admonition p.last {
 }
 
 div.highlight {
-    background-color: white;
+    background-color: #fff;
 }
 
 dt:target, .highlight {
     background: #FAF3E8;
 }
 
+div.warning {
+    background-color: #FCC;
+    border: 1px solid #FAA;
+}
+
+div.danger {
+    background-color: #FCC;
+    border: 1px solid #FAA;
+    -moz-box-shadow: 2px 2px 4px #D52C2C;
+    -webkit-box-shadow: 2px 2px 4px #D52C2C;
+    box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.error {
+    background-color: #FCC;
+    border: 1px solid #FAA;
+    -moz-box-shadow: 2px 2px 4px #D52C2C;
+    -webkit-box-shadow: 2px 2px 4px #D52C2C;
+    box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.caution {
+    background-color: #FCC;
+    border: 1px solid #FAA;
+}
+
+div.attention {
+    background-color: #FCC;
+    border: 1px solid #FAA;
+}
+
+div.important {
+    background-color: #EEE;
+    border: 1px solid #CCC;
+}
+
 div.note {
     background-color: #EEE;
     border: 1px solid #CCC;
 }
 
+div.tip {
+    background-color: #EEE;
+    border: 1px solid #CCC;
+}
+
+div.hint {
+    background-color: #EEE;
+    border: 1px solid #CCC;
+}
+
 div.seealso {
     background-color: #EEE;
     border: 1px solid #CCC;
 }
 
 div.topic {
-    background-color: #eee;
+    background-color: #EEE;
 }
 
 p.admonition-title {
@@ -309,16 +394,16 @@ tt.descname, code.descname {
 }
 
 img.screenshot {
-    -moz-box-shadow: 2px 2px 4px #eee;
-    -webkit-box-shadow: 2px 2px 4px #eee;
-    box-shadow: 2px 2px 4px #eee;
+    -moz-box-shadow: 2px 2px 4px #EEE;
+    -webkit-box-shadow: 2px 2px 4px #EEE;
+    box-shadow: 2px 2px 4px #EEE;
 }
 
 table.docutils {
     border: 1px solid #888;
-    -moz-box-shadow: 2px 2px 4px #eee;
-    -webkit-box-shadow: 2px 2px 4px #eee;
-    box-shadow: 2px 2px 4px #eee;
+    -moz-box-shadow: 2px 2px 4px #EEE;
+    -webkit-box-shadow: 2px 2px 4px #EEE;
+    box-shadow: 2px 2px 4px #EEE;
 }
 
 table.docutils td, table.docutils th {
@@ -359,7 +444,7 @@ table.field-list p {
 }
 
 table.footnote td.label {
-    width: 0px;
+    width: .1px;
     padding: 0.3em 0 0.3em 0.5em;
 }
 
@@ -382,6 +467,7 @@ blockquote {
 }
 
 ul, ol {
+    /* Matches the 30px from the narrow-screen "li > ul" selector below */
     margin: 10px 0 10px 30px;
     padding: 0;
 }
@@ -393,6 +479,10 @@ pre {
     line-height: 1.3em;
 }
 
+div.viewcode-block:target {
+    background: #ffd;
+}
+
 dl pre, blockquote pre, li pre {
     margin-left: 0;
     padding-left: 30px;
@@ -411,14 +501,19 @@ tt, code {
 
 tt.xref, code.xref, a tt {
     background-color: #FBFBFB;
-    border-bottom: 1px solid white;
+    border-bottom: 1px solid #fff;
 }
 
 a.reference {
     text-decoration: none;
     border-bottom: 1px dotted #004B6B;
 }
 
+/* Don't put an underline on images */
+a.image-reference, a.image-reference:hover {
+    border-bottom: none;
+}
+
 a.reference:hover {
     border-bottom: 1px solid #6D4100;
 }
@@ -468,6 +563,11 @@ a:hover tt, a:hover code {
     	margin-left: 0;
     }
 
+	li > ul {
+        /* Matches the 30px from the "ul, ol" selector above */
+		margin-left: 30px;
+	}
+
     .document {
     	width: auto;
     }
@@ -503,7 +603,7 @@ a:hover tt, a:hover code {
 
     div.documentwrapper {
         float: none;
-        background: white;
+        background: #fff;
     }
 
     div.sphinxsidebar {
@@ -518,7 +618,7 @@ a:hover tt, a:hover code {
 
     div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
     div.sphinxsidebar h3 a {
-        color: white;
+        color: #fff;
     }
 
     div.sphinxsidebar a {

diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css
@@ -52,6 +52,8 @@ div.sphinxsidebar {
     width: 230px;
     margin-left: -100%;
     font-size: 90%;
+    word-wrap: break-word;
+    overflow-wrap : break-word;
 }
 
 div.sphinxsidebar ul {
@@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] {
     width: 170px;
 }
 
-div.sphinxsidebar #searchbox input[type="submit"] {
-    width: 30px;
-}
-
 img {
     border: 0;
     max-width: 100%;
@@ -187,6 +185,13 @@ div.genindex-jumpbox {
 
 /* -- general body styles --------------------------------------------------- */
 
+div.body p, div.body dd, div.body li, div.body blockquote {
+    -moz-hyphens: auto;
+    -ms-hyphens: auto;
+    -webkit-hyphens: auto;
+    hyphens: auto;
+}
+
 a.headerlink {
     visibility: hidden;
 }

diff --git a/docs/_build/html/_static/css/badge_only.css b/docs/_build/html/_static/css/badge_only.css
diff --git a/docs/_build/html/_static/css/theme.css b/docs/_build/html/_static/css/theme.css
diff --git a/docs/_build/html/_static/custom.css b/docs/_build/html/_static/custom.css
@@ -0,0 +1 @@
+/* This file intentionally left blank. */