Skip to content

Commit

Permalink
Fix docs build redux. (#75)
Browse files Browse the repository at this point in the history
* Accomodate 'sphinx-autogen' whitespace change.

* Pin 'Sphinx', 'sphinx-rtd-theme' to avoid breakage.

* Regen docs.

Closes #55.
  • Loading branch information
tseaver authored Jul 24, 2019
1 parent 3230b46 commit 6f65783
Show file tree
Hide file tree
Showing 18 changed files with 96 additions and 82 deletions.
2 changes: 1 addition & 1 deletion docs/latest/.buildinfo
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: 8d55b386d69a0a5b4c4d005c7d3727d0
config: 7e1b338c2c9c8a7781dd9b0067280fb3
tags: 645f666f9bcd5a90fca523b33c5a78b7
8 changes: 4 additions & 4 deletions docs/latest/_sources/google.resumable_media.common.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
=================================

.. automodule:: google.resumable_media.common
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
============================================

.. automodule:: google.resumable_media.requests.download
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
==========================================

.. automodule:: google.resumable_media.requests.upload
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
15 changes: 15 additions & 0 deletions docs/latest/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,12 @@ img.align-center, .figure.align-center, object.align-center {
margin-right: auto;
}

img.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}

.align-left {
text-align: left;
}
Expand All @@ -297,6 +303,10 @@ img.align-center, .figure.align-center, object.align-center {
text-align: center;
}

.align-default {
text-align: center;
}

.align-right {
text-align: right;
}
Expand Down Expand Up @@ -368,6 +378,11 @@ table.align-center {
margin-right: auto;
}

table.align-default {
margin-left: auto;
margin-right: auto;
}

table caption span.caption-number {
font-style: italic;
}
Expand Down
7 changes: 4 additions & 3 deletions docs/latest/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -319,12 +319,13 @@ var Search = {
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
if (fullname.toLowerCase().indexOf(object) > -1) {
var fullnameLower = fullname.toLowerCase()
if (fullnameLower.indexOf(object) > -1) {
var score = 0;
var parts = fullname.split('.');
var parts = fullnameLower.split('.');
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
if (fullname == object || parts[parts.length - 1] == object) {
if (fullnameLower == object || parts[parts.length - 1] == object) {
score += Scorer.objNameMatch;
// matches in last name
} else if (parts[parts.length - 1].indexOf(object) > -1) {
Expand Down
30 changes: 14 additions & 16 deletions docs/latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,11 +184,11 @@ <h2 id="A">A</h2>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.ChunkedDownload.bytes_downloaded">bytes_downloaded (google.resumable_media.requests.download.ChunkedDownload attribute)</a>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.ChunkedDownload.bytes_downloaded">bytes_downloaded() (google.resumable_media.requests.download.ChunkedDownload property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.bytes_uploaded">bytes_uploaded (google.resumable_media.requests.upload.ResumableUpload attribute)</a>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.bytes_uploaded">bytes_uploaded() (google.resumable_media.requests.upload.ResumableUpload property)</a>
</li>
</ul></td>
</tr></table>
Expand All @@ -197,11 +197,9 @@ <h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.ChunkedDownload.chunk_size">chunk_size (google.resumable_media.requests.download.ChunkedDownload attribute)</a>

<ul>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.chunk_size">(google.resumable_media.requests.upload.ResumableUpload attribute)</a>
</li>
</ul></li>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.chunk_size">chunk_size() (google.resumable_media.requests.upload.ResumableUpload property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.ChunkedDownload">ChunkedDownload (class in google.resumable_media.requests.download)</a>
Expand Down Expand Up @@ -240,16 +238,16 @@ <h2 id="E">E</h2>
<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.ChunkedDownload.finished">finished (google.resumable_media.requests.download.ChunkedDownload attribute)</a>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.ChunkedDownload.finished">finished() (google.resumable_media.requests.download.ChunkedDownload property)</a>

<ul>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.Download.finished">(google.resumable_media.requests.download.Download attribute)</a>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.Download.finished">(google.resumable_media.requests.download.Download property)</a>
</li>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.MultipartUpload.finished">(google.resumable_media.requests.upload.MultipartUpload attribute)</a>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.MultipartUpload.finished">(google.resumable_media.requests.upload.MultipartUpload property)</a>
</li>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.finished">(google.resumable_media.requests.upload.ResumableUpload attribute)</a>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.finished">(google.resumable_media.requests.upload.ResumableUpload property)</a>
</li>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.SimpleUpload.finished">(google.resumable_media.requests.upload.SimpleUpload attribute)</a>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.SimpleUpload.finished">(google.resumable_media.requests.upload.SimpleUpload property)</a>
</li>
</ul></li>
</ul></td>
Expand Down Expand Up @@ -278,10 +276,10 @@ <h2 id="I">I</h2>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.initiate">initiate() (google.resumable_media.requests.upload.ResumableUpload method)</a>
</li>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.ChunkedDownload.invalid">invalid (google.resumable_media.requests.download.ChunkedDownload attribute)</a>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.ChunkedDownload.invalid">invalid() (google.resumable_media.requests.download.ChunkedDownload property)</a>

<ul>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.invalid">(google.resumable_media.requests.upload.ResumableUpload attribute)</a>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.invalid">(google.resumable_media.requests.upload.ResumableUpload property)</a>
</li>
</ul></li>
</ul></td>
Expand Down Expand Up @@ -338,7 +336,7 @@ <h2 id="R">R</h2>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.resumable_url">resumable_url (google.resumable_media.requests.upload.ResumableUpload attribute)</a>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.resumable_url">resumable_url() (google.resumable_media.requests.upload.ResumableUpload property)</a>
</li>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload">ResumableUpload (class in google.resumable_media.requests.upload)</a>
</li>
Expand Down Expand Up @@ -370,10 +368,10 @@ <h2 id="T">T</h2>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="google.resumable_media.common.html#google.resumable_media.common.TOO_MANY_REQUESTS">TOO_MANY_REQUESTS (in module google.resumable_media.common)</a>
</li>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.ChunkedDownload.total_bytes">total_bytes (google.resumable_media.requests.download.ChunkedDownload attribute)</a>
<li><a href="google.resumable_media.requests.download.html#google.resumable_media.requests.download.ChunkedDownload.total_bytes">total_bytes() (google.resumable_media.requests.download.ChunkedDownload property)</a>

<ul>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.total_bytes">(google.resumable_media.requests.upload.ResumableUpload attribute)</a>
<li><a href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.ResumableUpload.total_bytes">(google.resumable_media.requests.upload.ResumableUpload property)</a>
</li>
</ul></li>
</ul></td>
Expand Down
20 changes: 10 additions & 10 deletions docs/latest/google.resumable_media.requests.download.html
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,9 @@
</tr>
</tbody>
</table>
<dl class="attribute">
<dl class="method">
<dt id="google.resumable_media.requests.download.ChunkedDownload.bytes_downloaded">
<code class="descname">bytes_downloaded</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.bytes_downloaded" title="Permalink to this definition"></a></dt>
<em class="property">property </em><code class="descname">bytes_downloaded</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.bytes_downloaded" title="Permalink to this definition"></a></dt>
<dd><p>Number of bytes that have been downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
Expand Down Expand Up @@ -293,9 +293,9 @@
</table>
</dd></dl>

<dl class="attribute">
<dl class="method">
<dt id="google.resumable_media.requests.download.ChunkedDownload.finished">
<code class="descname">finished</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.finished" title="Permalink to this definition"></a></dt>
<em class="property">property </em><code class="descname">finished</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.finished" title="Permalink to this definition"></a></dt>
<dd><p>Flag indicating if the download has completed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
Expand All @@ -307,9 +307,9 @@
</table>
</dd></dl>

<dl class="attribute">
<dl class="method">
<dt id="google.resumable_media.requests.download.ChunkedDownload.invalid">
<code class="descname">invalid</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.invalid" title="Permalink to this definition"></a></dt>
<em class="property">property </em><code class="descname">invalid</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.invalid" title="Permalink to this definition"></a></dt>
<dd><p>Indicates if the download is in an invalid state.</p>
<p>This will occur if a call to <a class="reference internal" href="#google.resumable_media.requests.download.ChunkedDownload.consume_next_chunk" title="google.resumable_media.requests.download.ChunkedDownload.consume_next_chunk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">consume_next_chunk()</span></code></a> fails.</p>
<table class="docutils field-list" frame="void" rules="none">
Expand All @@ -322,9 +322,9 @@
</table>
</dd></dl>

<dl class="attribute">
<dl class="method">
<dt id="google.resumable_media.requests.download.ChunkedDownload.total_bytes">
<code class="descname">total_bytes</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.total_bytes" title="Permalink to this definition"></a></dt>
<em class="property">property </em><code class="descname">total_bytes</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.total_bytes" title="Permalink to this definition"></a></dt>
<dd><p>The total number of bytes to be downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
Expand Down Expand Up @@ -441,9 +441,9 @@
</table>
</dd></dl>

<dl class="attribute">
<dl class="method">
<dt id="google.resumable_media.requests.download.Download.finished">
<code class="descname">finished</code><a class="headerlink" href="#google.resumable_media.requests.download.Download.finished" title="Permalink to this definition"></a></dt>
<em class="property">property </em><code class="descname">finished</code><a class="headerlink" href="#google.resumable_media.requests.download.Download.finished" title="Permalink to this definition"></a></dt>
<dd><p>Flag indicating if the download has completed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/google.resumable_media.requests.html
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ <h2>Simple Uploads<a class="headerlink" href="#simple-uploads" title="Permalink
</pre></div>
</div>
<p>Even in the case of failure, we see that the upload is
<a class="reference internal" href="google.resumable_media.requests.upload.html#google.resumable_media.requests.upload.SimpleUpload.finished" title="google.resumable_media.requests.upload.SimpleUpload.finished"><code class="xref py py-attr docutils literal notranslate"><span class="pre">finished</span></code></a>, i.e. it cannot be re-used.</p>
<code class="xref py py-attr docutils literal notranslate"><span class="pre">finished</span></code>, i.e. it cannot be re-used.</p>
</div>
<div class="section" id="multipart-uploads">
<h2>Multipart Uploads<a class="headerlink" href="#multipart-uploads" title="Permalink to this headline"></a></h2>
Expand Down
Loading

0 comments on commit 6f65783

Please sign in to comment.