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

Commit b322f3d

Browse files
committed
Updated documentation by adding 1.0.0 details to the changelog and @adieyal to credits
1 parent 5527789 commit b322f3d

20 files changed

Lines changed: 109 additions & 79 deletions
4.21 KB
Binary file not shown.
490 Bytes
Binary file not shown.
122 Bytes
Binary file not shown.

docs/_build/html/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: c82c65e00d69e99faa4ee1a550ff4572
3+
config: 453b3ea34db921989096c2f7d99f4c38
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_sources/changelog.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
Changelog
22
---------
33

4+
1.0.0
5+
~~~~~
6+
7+
* Adopted `semantic versioning <http://semver.org/>`_ without breaking existing packages on PyPI
8+
* Fixed bugs with ``get_page_text``
9+
* Added keyword argument during initialization that allows you to override the ``BASE_URI`` and connect with independent clones of DocumentCloud. Contributed by `Adi Eyal <https://github.com/adieyal>`_.
10+
* Refactored unit tests to run more quickly and require fewer web requests
11+
* Documentation moved from the gh-pages branch to master and refactored to be published via `ReadTheDocs <http://readthedocs.org>`_.
12+
413
0.2
514
~~~
615

docs/_build/html/_sources/credits.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ But it would not be possible without:
77

88
* `The DocumentCloud team <https://www.documentcloud.org/about>`_.
99
* `Chris Amico <https://github.com/eyeseast>`_, `Christopher Groskopf <https://github.com/onyxfish/>`_ and `Mitchell Kotler <http://www.muckrock.com/blog/using-the-documentcloud-api/>`_, who broke ground with code that I've adapted.
10-
* Fixes from friendly people like `Joe Germuska <https://github.com/JoeGermuska>`_ and `Shane Shifflet <https://twitter.com/#!/shaneshifflett>`_.
10+
* Fixes from friendly people like `Joe Germuska <https://github.com/JoeGermuska>`_, `Shane Shifflet <https://twitter.com/#!/shaneshifflett>`_ and `Adi Eyal <https://github.com/adieyal>`_.
1111

docs/_build/html/changelog.html

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

9-
<title>Changelog &mdash; python-documentcloud 0.2 documentation</title>
9+
<title>Changelog &mdash; python-documentcloud 1.0.0 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" />
1313

1414
<script type="text/javascript">
1515
var DOCUMENTATION_OPTIONS = {
1616
URL_ROOT: './',
17-
VERSION: '0.2',
17+
VERSION: '1.0.0',
1818
COLLAPSE_INDEX: false,
1919
FILE_SUFFIX: '.html',
2020
HAS_SOURCE: true
@@ -23,7 +23,7 @@
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 1.0.0 documentation" href="index.html" />
2727
<link rel="next" title="Credits" href="credits.html" />
2828
<link rel="prev" title="Other objects" href="otherobjects.html" />
2929
</head>
@@ -40,7 +40,7 @@ <h3>Navigation</h3>
4040
<li class="right" >
4141
<a href="otherobjects.html" title="Other objects"
4242
accesskey="P">previous</a> |</li>
43-
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
43+
<li><a href="index.html">python-documentcloud 1.0.0 documentation</a> &raquo;</li>
4444
</ul>
4545
</div>
4646

@@ -52,15 +52,25 @@ <h3>Navigation</h3>
5252
<div class="section" id="changelog">
5353
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline"></a></h1>
5454
<div class="section" id="id1">
55-
<h2>0.2<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
55+
<h2>1.0.0<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
56+
<ul class="simple">
57+
<li>Adopted <a class="reference external" href="http://semver.org/">semantic versioning</a> without breaking existing packages on PyPI</li>
58+
<li>Fixed bugs with <tt class="docutils literal"><span class="pre">get_page_text</span></tt></li>
59+
<li>Added keyword argument during initialization that allows you to override the <tt class="docutils literal"><span class="pre">BASE_URI</span></tt> and connect with independent clones of DocumentCloud. Contributed by <a class="reference external" href="https://github.com/adieyal">Adi Eyal</a>.</li>
60+
<li>Refactored unit tests to run more quickly and require fewer web requests</li>
61+
<li>Documentation moved from the gh-pages branch to master and refactored to be published via <a class="reference external" href="http://readthedocs.org">ReadTheDocs</a>.</li>
62+
</ul>
63+
</div>
64+
<div class="section" id="id2">
65+
<h2>0.2<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
5666
<ul class="simple">
5767
<li>Python 3 support</li>
5868
<li>PEP8 and PyFlakes compliance</li>
5969
<li>Coverage reports on testing via coveralls.io</li>
6070
</ul>
6171
</div>
62-
<div class="section" id="id2">
63-
<h2>0.16<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
72+
<div class="section" id="id3">
73+
<h2>0.16<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h2>
6474
<ul class="simple">
6575
<li>Continuous integration testing with TravisCI</li>
6676
<li>Fixed bug with empty strings in Document descriptions</li>
@@ -71,16 +81,16 @@ <h2>0.16<a class="headerlink" href="#id2" title="Permalink to this headline">¶<
7181
<li>Added access checks when retrieving txt, pdf, img about a document</li>
7282
</ul>
7383
</div>
74-
<div class="section" id="id3">
75-
<h2>0.15<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h2>
84+
<div class="section" id="id4">
85+
<h2>0.15<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h2>
7686
<ul class="simple">
7787
<li>File objects can now be submitted for uploading</li>
7888
<li>Added more support for unicode data thanks to contributions by <a class="reference external" href="https://twitter.com/#!/shaneshifflett">Shane Shifflet</a>.</li>
7989
<li>Smarter lazy loading of Document attributes missing from a search</li>
8090
</ul>
8191
</div>
82-
<div class="section" id="id4">
83-
<h2>0.14<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h2>
92+
<div class="section" id="id5">
93+
<h2>0.14<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
8494
<ul class="simple">
8595
<li>Added <tt class="docutils literal"><span class="pre">data</span></tt> attribute on Document for storing dictionaries of arbitrary metadata</li>
8696
<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>
@@ -89,22 +99,22 @@ <h2>0.14<a class="headerlink" href="#id4" title="Permalink to this headline">¶<
8999
<li>Added all Document upload arguments to <tt class="docutils literal"><span class="pre">upload_directory</span></tt> method</li>
90100
</ul>
91101
</div>
92-
<div class="section" id="id5">
93-
<h2>0.13<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
102+
<div class="section" id="id6">
103+
<h2>0.13<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h2>
94104
<ul class="simple">
95105
<li><tt class="docutils literal"><span class="pre">upload_directory</span></tt> method for documents</li>
96106
</ul>
97107
</div>
98-
<div class="section" id="id6">
99-
<h2>0.12<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h2>
108+
<div class="section" id="id7">
109+
<h2>0.12<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h2>
100110
<ul class="simple">
101111
<li><tt class="docutils literal"><span class="pre">get_or_create_by_title</span></tt> method for projects</li>
102112
<li>Document and project creation methods now return an object, not the new id.</li>
103113
<li>Projects can pulled by id or by title</li>
104114
</ul>
105115
</div>
106-
<div class="section" id="id7">
107-
<h2>0.11<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h2>
116+
<div class="section" id="id8">
117+
<h2>0.11<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h2>
108118
<ul class="simple">
109119
<li>Document search now returns <tt class="docutils literal"><span class="pre">mentions</span></tt> of the keyword in the documents</li>
110120
<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>
@@ -122,13 +132,14 @@ <h2>0.11<a class="headerlink" href="#id7" title="Permalink to this headline">¶<
122132
<h3><a href="index.html">Table Of Contents</a></h3>
123133
<ul>
124134
<li><a class="reference internal" href="#">Changelog</a><ul>
125-
<li><a class="reference internal" href="#id1">0.2</a></li>
126-
<li><a class="reference internal" href="#id2">0.16</a></li>
127-
<li><a class="reference internal" href="#id3">0.15</a></li>
128-
<li><a class="reference internal" href="#id4">0.14</a></li>
129-
<li><a class="reference internal" href="#id5">0.13</a></li>
130-
<li><a class="reference internal" href="#id6">0.12</a></li>
131-
<li><a class="reference internal" href="#id7">0.11</a></li>
135+
<li><a class="reference internal" href="#id1">1.0.0</a></li>
136+
<li><a class="reference internal" href="#id2">0.2</a></li>
137+
<li><a class="reference internal" href="#id3">0.16</a></li>
138+
<li><a class="reference internal" href="#id4">0.15</a></li>
139+
<li><a class="reference internal" href="#id5">0.14</a></li>
140+
<li><a class="reference internal" href="#id6">0.13</a></li>
141+
<li><a class="reference internal" href="#id7">0.12</a></li>
142+
<li><a class="reference internal" href="#id8">0.11</a></li>
132143
</ul>
133144
</li>
134145
</ul>
@@ -173,7 +184,7 @@ <h3>Navigation</h3>
173184
<li class="right" >
174185
<a href="otherobjects.html" title="Other objects"
175186
>previous</a> |</li>
176-
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
187+
<li><a href="index.html">python-documentcloud 1.0.0 documentation</a> &raquo;</li>
177188
</ul>
178189
</div>
179190
<div class="footer">

docs/_build/html/credits.html

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

9-
<title>Credits &mdash; python-documentcloud 0.2 documentation</title>
9+
<title>Credits &mdash; python-documentcloud 1.0.0 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" />
1313

1414
<script type="text/javascript">
1515
var DOCUMENTATION_OPTIONS = {
1616
URL_ROOT: './',
17-
VERSION: '0.2',
17+
VERSION: '1.0.0',
1818
COLLAPSE_INDEX: false,
1919
FILE_SUFFIX: '.html',
2020
HAS_SOURCE: true
@@ -23,7 +23,7 @@
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 1.0.0 documentation" href="index.html" />
2727
<link rel="prev" title="Changelog" href="changelog.html" />
2828
</head>
2929
<body>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="changelog.html" title="Changelog"
3838
accesskey="P">previous</a> |</li>
39-
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
39+
<li><a href="index.html">python-documentcloud 1.0.0 documentation</a> &raquo;</li>
4040
</ul>
4141
</div>
4242

@@ -52,7 +52,7 @@ <h1>Credits<a class="headerlink" href="#credits" title="Permalink to this headli
5252
<ul class="simple">
5353
<li><a class="reference external" href="https://www.documentcloud.org/about">The DocumentCloud team</a>.</li>
5454
<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>
55-
<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>
55+
<li>Fixes from friendly people like <a class="reference external" href="https://github.com/JoeGermuska">Joe Germuska</a>, <a class="reference external" href="https://twitter.com/#!/shaneshifflett">Shane Shifflet</a> and <a class="reference external" href="https://github.com/adieyal">Adi Eyal</a>.</li>
5656
</ul>
5757
</div>
5858

@@ -96,7 +96,7 @@ <h3>Navigation</h3>
9696
<li class="right" >
9797
<a href="changelog.html" title="Changelog"
9898
>previous</a> |</li>
99-
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
99+
<li><a href="index.html">python-documentcloud 1.0.0 documentation</a> &raquo;</li>
100100
</ul>
101101
</div>
102102
<div class="footer">

docs/_build/html/documents.html

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

9-
<title>Documents &mdash; python-documentcloud 0.2 documentation</title>
9+
<title>Documents &mdash; python-documentcloud 1.0.0 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" />
1313

1414
<script type="text/javascript">
1515
var DOCUMENTATION_OPTIONS = {
1616
URL_ROOT: './',
17-
VERSION: '0.2',
17+
VERSION: '1.0.0',
1818
COLLAPSE_INDEX: false,
1919
FILE_SUFFIX: '.html',
2020
HAS_SOURCE: true
@@ -23,7 +23,7 @@
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 1.0.0 documentation" href="index.html" />
2727
<link rel="next" title="Projects" href="projects.html" />
2828
<link rel="prev" title="Getting started" href="gettingstarted.html" />
2929
</head>
@@ -40,7 +40,7 @@ <h3>Navigation</h3>
4040
<li class="right" >
4141
<a href="gettingstarted.html" title="Getting started"
4242
accesskey="P">previous</a> |</li>
43-
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
43+
<li><a href="index.html">python-documentcloud 1.0.0 documentation</a> &raquo;</li>
4444
</ul>
4545
</div>
4646

@@ -473,7 +473,7 @@ <h3>Navigation</h3>
473473
<li class="right" >
474474
<a href="gettingstarted.html" title="Getting started"
475475
>previous</a> |</li>
476-
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
476+
<li><a href="index.html">python-documentcloud 1.0.0 documentation</a> &raquo;</li>
477477
</ul>
478478
</div>
479479
<div class="footer">

docs/_build/html/genindex.html

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

10-
<title>Index &mdash; python-documentcloud 0.2 documentation</title>
10+
<title>Index &mdash; python-documentcloud 1.0.0 documentation</title>
1111

1212
<link rel="stylesheet" href="_static/default.css" type="text/css" />
1313
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1414

1515
<script type="text/javascript">
1616
var DOCUMENTATION_OPTIONS = {
1717
URL_ROOT: './',
18-
VERSION: '0.2',
18+
VERSION: '1.0.0',
1919
COLLAPSE_INDEX: false,
2020
FILE_SUFFIX: '.html',
2121
HAS_SOURCE: true
@@ -24,7 +24,7 @@
2424
<script type="text/javascript" src="_static/jquery.js"></script>
2525
<script type="text/javascript" src="_static/underscore.js"></script>
2626
<script type="text/javascript" src="_static/doctools.js"></script>
27-
<link rel="top" title="python-documentcloud 0.2 documentation" href="index.html" />
27+
<link rel="top" title="python-documentcloud 1.0.0 documentation" href="index.html" />
2828
</head>
2929
<body>
3030
<div class="related">
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
3333
<li class="right" style="margin-right: 10px">
3434
<a href="#" title="General Index"
3535
accesskey="I">index</a></li>
36-
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
36+
<li><a href="index.html">python-documentcloud 1.0.0 documentation</a> &raquo;</li>
3737
</ul>
3838
</div>
3939

@@ -538,7 +538,7 @@ <h3>Navigation</h3>
538538
<li class="right" style="margin-right: 10px">
539539
<a href="#" title="General Index"
540540
>index</a></li>
541-
<li><a href="index.html">python-documentcloud 0.2 documentation</a> &raquo;</li>
541+
<li><a href="index.html">python-documentcloud 1.0.0 documentation</a> &raquo;</li>
542542
</ul>
543543
</div>
544544
<div class="footer">

0 commit comments

Comments
 (0)