Skip to content
This repository was archived by the owner on Jan 7, 2021. It is now read-only.

Commit 74b4044

Browse files
committed
Another take
1 parent 352e1b1 commit 74b4044

15 files changed

Lines changed: 80 additions & 118 deletions
288 Bytes
Binary file not shown.
328 Bytes
Binary file not shown.
-2.32 KB
Binary file not shown.

docs/_build/doctrees/index.doctree

-19.7 KB
Binary file not shown.

docs/_build/html/_sources/changelog.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Changelog
2+
---------
3+
14
0.2
25
~~~
36

docs/_build/html/_sources/credits.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Credits
2+
-------
3+
14
The lead developer of this project is `Ben Welsh <http://palewi.re/who-is-ben-welsh/>`_.
25

36
But it would not be possible without:

docs/_build/html/_sources/index.txt

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,8 @@ User Documentation
2020
documents
2121
projects
2222
otherobjects
23-
24-
Changelog
25-
---------
26-
27-
.. include:: changelog.rst
28-
29-
Credits
30-
---------
31-
32-
.. include:: credits.rst
23+
changelog
24+
credits
3325

3426
Contributing
3527
------------

docs/_build/html/changelog.html

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88

9-
<title>0.2 &mdash; python-documentcloud 0.2 documentation</title>
9+
<title>Changelog &mdash; python-documentcloud 0.2 documentation</title>
1010

1111
<link rel="stylesheet" href="_static/default.css" type="text/css" />
1212
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -23,7 +23,9 @@
2323
<script type="text/javascript" src="_static/jquery.js"></script>
2424
<script type="text/javascript" src="_static/underscore.js"></script>
2525
<script type="text/javascript" src="_static/doctools.js"></script>
26-
<link rel="top" title="python-documentcloud 0.2 documentation" href="index.html" />
26+
<link rel="top" title="python-documentcloud 0.2 documentation" href="index.html" />
27+
<link rel="next" title="Credits" href="credits.html" />
28+
<link rel="prev" title="Other objects" href="otherobjects.html" />
2729
</head>
2830
<body>
2931
<div class="related">
@@ -32,6 +34,12 @@ <h3>Navigation</h3>
3234
<li class="right" style="margin-right: 10px">
3335
<a href="genindex.html" title="General Index"
3436
accesskey="I">index</a></li>
37+
<li class="right" >
38+
<a href="credits.html" title="Credits"
39+
accesskey="N">next</a> |</li>
40+
<li class="right" >
41+
<a href="otherobjects.html" title="Other objects"
42+
accesskey="P">previous</a> |</li>
3543
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
3644
</ul>
3745
</div>
@@ -41,16 +49,18 @@ <h3>Navigation</h3>
4149
<div class="bodywrapper">
4250
<div class="body">
4351

44-
<div class="section" id="id1">
45-
<h1>0.2<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h1>
52+
<div class="section" id="changelog">
53+
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline"></a></h1>
54+
<div class="section" id="id1">
55+
<h2>0.2<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
4656
<ul class="simple">
4757
<li>Python 3 support</li>
4858
<li>PEP8 and PyFlakes compliance</li>
4959
<li>Coverage reports on testing via coveralls.io</li>
5060
</ul>
5161
</div>
5262
<div class="section" id="id2">
53-
<h1>0.16<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h1>
63+
<h2>0.16<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
5464
<ul class="simple">
5565
<li>Continuous integration testing with TravisCI</li>
5666
<li>Fixed bug with empty strings in Document descriptions</li>
@@ -62,15 +72,15 @@ <h1>0.16<a class="headerlink" href="#id2" title="Permalink to this headline">¶<
6272
</ul>
6373
</div>
6474
<div class="section" id="id3">
65-
<h1>0.15<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h1>
75+
<h2>0.15<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h2>
6676
<ul class="simple">
6777
<li>File objects can now be submitted for uploading</li>
6878
<li>Added more support for unicode data thanks to contributions by <a class="reference external" href="https://twitter.com/#!/shaneshifflett">Shane Shifflet</a>.</li>
6979
<li>Smarter lazy loading of Document attributes missing from a search</li>
7080
</ul>
7181
</div>
7282
<div class="section" id="id4">
73-
<h1>0.14<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h1>
83+
<h2>0.14<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h2>
7484
<ul class="simple">
7585
<li>Added <tt class="docutils literal"><span class="pre">data</span></tt> attribute on Document for storing dictionaries of arbitrary metadata</li>
7686
<li>Added <tt class="docutils literal"><span class="pre">secure</span></tt> option for Document uploads to prevent data from being sent to OpenCalais</li>
@@ -80,26 +90,27 @@ <h1>0.14<a class="headerlink" href="#id4" title="Permalink to this headline">¶<
8090
</ul>
8191
</div>
8292
<div class="section" id="id5">
83-
<h1>0.13<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h1>
93+
<h2>0.13<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
8494
<ul class="simple">
8595
<li><tt class="docutils literal"><span class="pre">upload_directory</span></tt> method for documents</li>
8696
</ul>
8797
</div>
8898
<div class="section" id="id6">
89-
<h1>0.12<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h1>
99+
<h2>0.12<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h2>
90100
<ul class="simple">
91101
<li><tt class="docutils literal"><span class="pre">get_or_create_by_title</span></tt> method for projects</li>
92102
<li>Document and project creation methods now return an object, not the new id.</li>
93103
<li>Projects can pulled by id or by title</li>
94104
</ul>
95105
</div>
96106
<div class="section" id="id7">
97-
<h1>0.11<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h1>
107+
<h2>0.11<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h2>
98108
<ul class="simple">
99109
<li>Document search now returns <tt class="docutils literal"><span class="pre">mentions</span></tt> of the keyword in the documents</li>
100110
<li><tt class="docutils literal"><span class="pre">related_url</span></tt> and <tt class="docutils literal"><span class="pre">published_url</span></tt> attributes now more easily accessible</li>
101111
<li><tt class="docutils literal"><span class="pre">normal</span></tt> sized images now available</li>
102112
</ul>
113+
</div>
103114
</div>
104115

105116

@@ -110,15 +121,24 @@ <h1>0.11<a class="headerlink" href="#id7" title="Permalink to this headline">¶<
110121
<div class="sphinxsidebarwrapper">
111122
<h3><a href="index.html">Table Of Contents</a></h3>
112123
<ul>
113-
<li><a class="reference internal" href="#">0.2</a></li>
124+
<li><a class="reference internal" href="#">Changelog</a><ul>
125+
<li><a class="reference internal" href="#id1">0.2</a></li>
114126
<li><a class="reference internal" href="#id2">0.16</a></li>
115127
<li><a class="reference internal" href="#id3">0.15</a></li>
116128
<li><a class="reference internal" href="#id4">0.14</a></li>
117129
<li><a class="reference internal" href="#id5">0.13</a></li>
118130
<li><a class="reference internal" href="#id6">0.12</a></li>
119131
<li><a class="reference internal" href="#id7">0.11</a></li>
132+
</ul>
133+
</li>
120134
</ul>
121135

136+
<h4>Previous topic</h4>
137+
<p class="topless"><a href="otherobjects.html"
138+
title="previous chapter">Other objects</a></p>
139+
<h4>Next topic</h4>
140+
<p class="topless"><a href="credits.html"
141+
title="next chapter">Credits</a></p>
122142
<h3>This Page</h3>
123143
<ul class="this-page-menu">
124144
<li><a href="_sources/changelog.txt"
@@ -147,6 +167,12 @@ <h3>Navigation</h3>
147167
<li class="right" style="margin-right: 10px">
148168
<a href="genindex.html" title="General Index"
149169
>index</a></li>
170+
<li class="right" >
171+
<a href="credits.html" title="Credits"
172+
>next</a> |</li>
173+
<li class="right" >
174+
<a href="otherobjects.html" title="Other objects"
175+
>previous</a> |</li>
150176
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
151177
</ul>
152178
</div>

docs/_build/html/credits.html

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88

9-
<title>&lt;no title&gt; &mdash; python-documentcloud 0.2 documentation</title>
9+
<title>Credits &mdash; python-documentcloud 0.2 documentation</title>
1010

1111
<link rel="stylesheet" href="_static/default.css" type="text/css" />
1212
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -23,7 +23,8 @@
2323
<script type="text/javascript" src="_static/jquery.js"></script>
2424
<script type="text/javascript" src="_static/underscore.js"></script>
2525
<script type="text/javascript" src="_static/doctools.js"></script>
26-
<link rel="top" title="python-documentcloud 0.2 documentation" href="index.html" />
26+
<link rel="top" title="python-documentcloud 0.2 documentation" href="index.html" />
27+
<link rel="prev" title="Changelog" href="changelog.html" />
2728
</head>
2829
<body>
2930
<div class="related">
@@ -32,6 +33,9 @@ <h3>Navigation</h3>
3233
<li class="right" style="margin-right: 10px">
3334
<a href="genindex.html" title="General Index"
3435
accesskey="I">index</a></li>
36+
<li class="right" >
37+
<a href="changelog.html" title="Changelog"
38+
accesskey="P">previous</a> |</li>
3539
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
3640
</ul>
3741
</div>
@@ -41,20 +45,26 @@ <h3>Navigation</h3>
4145
<div class="bodywrapper">
4246
<div class="body">
4347

44-
<p>The lead developer of this project is <a class="reference external" href="http://palewi.re/who-is-ben-welsh/">Ben Welsh</a>.</p>
48+
<div class="section" id="credits">
49+
<h1>Credits<a class="headerlink" href="#credits" title="Permalink to this headline"></a></h1>
50+
<p>The lead developer of this project is <a class="reference external" href="http://palewi.re/who-is-ben-welsh/">Ben Welsh</a>.</p>
4551
<p>But it would not be possible without:</p>
4652
<ul class="simple">
4753
<li><a class="reference external" href="https://www.documentcloud.org/about">The DocumentCloud team</a>.</li>
4854
<li><a class="reference external" href="https://github.com/eyeseast">Chris Amico</a>, <a class="reference external" href="https://github.com/onyxfish/">Christopher Groskopf</a> and <a class="reference external" href="http://www.muckrock.com/blog/using-the-documentcloud-api/">Mitchell Kotler</a>, who broke ground with code that I&#8217;ve adapted.</li>
4955
<li>Fixes from friendly people like <a class="reference external" href="https://github.com/JoeGermuska">Joe Germuska</a> and <a class="reference external" href="https://twitter.com/#!/shaneshifflett">Shane Shifflet</a>.</li>
5056
</ul>
57+
</div>
5158

5259

5360
</div>
5461
</div>
5562
</div>
5663
<div class="sphinxsidebar">
5764
<div class="sphinxsidebarwrapper">
65+
<h4>Previous topic</h4>
66+
<p class="topless"><a href="changelog.html"
67+
title="previous chapter">Changelog</a></p>
5868
<h3>This Page</h3>
5969
<ul class="this-page-menu">
6070
<li><a href="_sources/credits.txt"
@@ -83,6 +93,9 @@ <h3>Navigation</h3>
8393
<li class="right" style="margin-right: 10px">
8494
<a href="genindex.html" title="General Index"
8595
>index</a></li>
96+
<li class="right" >
97+
<a href="changelog.html" title="Changelog"
98+
>previous</a> |</li>
8699
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
87100
</ul>
88101
</div>

docs/_build/html/index.html

Lines changed: 10 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -93,82 +93,20 @@ <h2>User Documentation<a class="headerlink" href="#user-documentation" title="Pe
9393
<li class="toctree-l2"><a class="reference internal" href="otherobjects.html#sections">Sections</a></li>
9494
</ul>
9595
</li>
96+
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
97+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">0.2</a></li>
98+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">0.16</a></li>
99+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">0.15</a></li>
100+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">0.14</a></li>
101+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">0.13</a></li>
102+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id6">0.12</a></li>
103+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">0.11</a></li>
96104
</ul>
97-
</div>
98-
</div>
99-
<div class="section" id="changelog">
100-
<h2>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline"></a></h2>
101-
<div class="section" id="id1">
102-
<h3>0.2<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
103-
<ul class="simple">
104-
<li>Python 3 support</li>
105-
<li>PEP8 and PyFlakes compliance</li>
106-
<li>Coverage reports on testing via coveralls.io</li>
107-
</ul>
108-
</div>
109-
<div class="section" id="id2">
110-
<h3>0.16<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
111-
<ul class="simple">
112-
<li>Continuous integration testing with TravisCI</li>
113-
<li>Fixed bug with empty strings in Document descriptions</li>
114-
<li>Raise errors when a user tries to save a data keyword reserved by DocumentCloud</li>
115-
<li>Allow all-caps file extensions</li>
116-
<li>Retry requests that fail with an increasing backoff delay</li>
117-
<li>Fixed a bug in how titles are assigned to a file object</li>
118-
<li>Added access checks when retrieving txt, pdf, img about a document</li>
119-
</ul>
120-
</div>
121-
<div class="section" id="id3">
122-
<h3>0.15<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
123-
<ul class="simple">
124-
<li>File objects can now be submitted for uploading</li>
125-
<li>Added more support for unicode data thanks to contributions by <a class="reference external" href="https://twitter.com/#!/shaneshifflett">Shane Shifflet</a>.</li>
126-
<li>Smarter lazy loading of Document attributes missing from a search</li>
127-
</ul>
128-
</div>
129-
<div class="section" id="id4">
130-
<h3>0.14<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
131-
<ul class="simple">
132-
<li>Added <tt class="docutils literal"><span class="pre">data</span></tt> attribute on Document for storing dictionaries of arbitrary metadata</li>
133-
<li>Added <tt class="docutils literal"><span class="pre">secure</span></tt> option for Document uploads to prevent data from being sent to OpenCalais</li>
134-
<li>Added <tt class="docutils literal"><span class="pre">save</span></tt> alias on Document and Project objects that uses the pre-existing <tt class="docutils literal"><span class="pre">put</span></tt> command</li>
135-
<li>Fixed to url encoding to makes the system more unicode friendly</li>
136-
<li>Added all Document upload arguments to <tt class="docutils literal"><span class="pre">upload_directory</span></tt> method</li>
137-
</ul>
138-
</div>
139-
<div class="section" id="id5">
140-
<h3>0.13<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
141-
<ul class="simple">
142-
<li><tt class="docutils literal"><span class="pre">upload_directory</span></tt> method for documents</li>
143-
</ul>
144-
</div>
145-
<div class="section" id="id6">
146-
<h3>0.12<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
147-
<ul class="simple">
148-
<li><tt class="docutils literal"><span class="pre">get_or_create_by_title</span></tt> method for projects</li>
149-
<li>Document and project creation methods now return an object, not the new id.</li>
150-
<li>Projects can pulled by id or by title</li>
151-
</ul>
152-
</div>
153-
<div class="section" id="id7">
154-
<h3>0.11<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
155-
<ul class="simple">
156-
<li>Document search now returns <tt class="docutils literal"><span class="pre">mentions</span></tt> of the keyword in the documents</li>
157-
<li><tt class="docutils literal"><span class="pre">related_url</span></tt> and <tt class="docutils literal"><span class="pre">published_url</span></tt> attributes now more easily accessible</li>
158-
<li><tt class="docutils literal"><span class="pre">normal</span></tt> sized images now available</li>
105+
</li>
106+
<li class="toctree-l1"><a class="reference internal" href="credits.html">Credits</a></li>
159107
</ul>
160108
</div>
161109
</div>
162-
<div class="section" id="credits">
163-
<h2>Credits<a class="headerlink" href="#credits" title="Permalink to this headline"></a></h2>
164-
<p>The lead developer of this project is <a class="reference external" href="http://palewi.re/who-is-ben-welsh/">Ben Welsh</a>.</p>
165-
<p>But it would not be possible without:</p>
166-
<ul class="simple">
167-
<li><a class="reference external" href="https://www.documentcloud.org/about">The DocumentCloud team</a>.</li>
168-
<li><a class="reference external" href="https://github.com/eyeseast">Chris Amico</a>, <a class="reference external" href="https://github.com/onyxfish/">Christopher Groskopf</a> and <a class="reference external" href="http://www.muckrock.com/blog/using-the-documentcloud-api/">Mitchell Kotler</a>, who broke ground with code that I&#8217;ve adapted.</li>
169-
<li>Fixes from friendly people like <a class="reference external" href="https://github.com/JoeGermuska">Joe Germuska</a> and <a class="reference external" href="https://twitter.com/#!/shaneshifflett">Shane Shifflet</a>.</li>
170-
</ul>
171-
</div>
172110
<div class="section" id="contributing">
173111
<h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline"></a></h2>
174112
<ul class="simple">
@@ -192,17 +130,6 @@ <h3><a href="#">Table Of Contents</a></h3>
192130
<li><a class="reference internal" href="#">python-documentcloud</a><ul>
193131
<li><a class="reference internal" href="#features">Features</a></li>
194132
<li><a class="reference internal" href="#user-documentation">User Documentation</a></li>
195-
<li><a class="reference internal" href="#changelog">Changelog</a><ul>
196-
<li><a class="reference internal" href="#id1">0.2</a></li>
197-
<li><a class="reference internal" href="#id2">0.16</a></li>
198-
<li><a class="reference internal" href="#id3">0.15</a></li>
199-
<li><a class="reference internal" href="#id4">0.14</a></li>
200-
<li><a class="reference internal" href="#id5">0.13</a></li>
201-
<li><a class="reference internal" href="#id6">0.12</a></li>
202-
<li><a class="reference internal" href="#id7">0.11</a></li>
203-
</ul>
204-
</li>
205-
<li><a class="reference internal" href="#credits">Credits</a></li>
206133
<li><a class="reference internal" href="#contributing">Contributing</a></li>
207134
</ul>
208135
</li>

0 commit comments

Comments
 (0)