Clean documentation

+ Fix docs generation for converters/feedparser.
+ Eliminate lingering `toJSON` reference (#10).

Author: lukasschwab

.gitignore

@@ -1,3 +1,4 @@
+.vscode
 release.sh
 
 #####=== Python ===#####

README.md

@@ -60,7 +60,7 @@ print(feed.to_json()
 + `Item`
 + `Attachment`
 
-Note, `jsonfeed` is designed to be minimally restrictive. It does not require fields that are not required in the JSON Feed spec. This means it's possible to construct nonmeaningful JSON feeds (e.g. with this valid `Author` object: `{}`).
+Note, `jsonfeed` is designed to be minimally restrictive. It does not require fields that are not required in the JSON Feed spec. This means it's possible to construct non-meaningful JSON feeds (e.g. with this valid `Author` object: `{}`).
 
 ### Examples
 

docs/jsonfeed.html

@@ -134,7 +134,7 @@ <h1 class="modulename">
 
                         <div class="docstring"><h1 id="jsonfeed">jsonfeed</h1>
 
-<p><a href="https://pypi.org/project/jsonfeed-util/"><img src="https://img.shields.io/pypi/v/jsonfeed-util" alt="PyPI" /></a> <a href="https://www.python.org/downloads/release/python-360/"><img src="https://img.shields.io/badge/python-3.6-blue.svg" alt="Python 3.6" /></a> <a href="https://github.com/lukasschwab/jsonfeed/actions?query=branch%3Amaster"><img src="https://img.shields.io/github/actions/workflow/status/lukasschwab/jsonfeed/python-package.yml?branch=master" alt="GitHub Workflow Status (branch)" /></a> <a href="https://lukasschwab.me/jsonfeed/index.html"><img src="https://img.shields.io/badge/docs-hosted-brightgreen" alt="Full package documentation" /></a></p>
+<p><a href="https://pypi.org/project/jsonfeed-util/"><img src="https://img.shields.io/pypi/v/jsonfeed-util" alt="PyPI" /></a> <a href="https://github.com/lukasschwab/jsonfeed/actions?query=branch%3Amaster"><img src="https://img.shields.io/github/actions/workflow/status/lukasschwab/jsonfeed/python-package.yml?branch=master" alt="GitHub Workflow Status (branch)" /></a> <a href="https://lukasschwab.me/jsonfeed/index.html"><img src="https://img.shields.io/badge/docs-hosted-brightgreen" alt="Full package documentation" /></a></p>
 
 <p><code><a href="">jsonfeed</a></code> is a Python package for parsing and constructing <a href="https://jsonfeed.org/version/1.1">JSON Feeds</a>. It explicitly supports JSON Feed Version 1.1.</p>
 
@@ -147,7 +147,7 @@ <h3 id="installation">Installation</h3>
 <p>Install this package with <code>pip</code>:</p>
 
 <div class="pdoc-code codehilite">
-<pre><span></span><code>$ pip install jsonfeed-util
+<pre><span></span><code>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>jsonfeed-util
 </code></pre>
 </div>
 
@@ -187,7 +187,7 @@ <h3 id="constructing-a-json-feed">Constructing a JSON feed</h3>
 <span class="n">item</span> <span class="o">=</span> <span class="n">jf</span><span class="o">.</span><span class="n">Item</span><span class="p">(</span><span class="s2">&quot;some_item_id&quot;</span><span class="p">)</span>
 <span class="n">feed</span><span class="o">.</span><span class="n">items</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
-<span class="nb">print</span><span class="p">(</span><span class="n">feed</span><span class="o">.</span><span class="n">toJSON</span><span class="p">())</span>
+<span class="nb">print</span><span class="p">(</span><span class="n">feed</span><span class="o">.</span><span class="n">to_json</span><span class="p">()</span>
 </code></pre>
 </div>
 
@@ -201,7 +201,7 @@ <h3 id="constructing-a-json-feed">Constructing a JSON feed</h3>
 <li><code><a href="#Attachment">Attachment</a></code></li>
 </ul>
 
-<p>Note, <code><a href="">jsonfeed</a></code> is designed to be minimally restrictive. It does not require fields that are not required in the JSON Feed spec. This means it's possible to construct nonmeaningful JSON feeds (e.g. with this valid <code><a href="#Author">Author</a></code> object: <code>{}</code>).</p>
+<p>Note, <code><a href="">jsonfeed</a></code> is designed to be minimally restrictive. It does not require fields that are not required in the JSON Feed spec. This means it's possible to construct non-meaningful JSON feeds (e.g. with this valid <code><a href="#Author">Author</a></code> object: <code>{}</code>).</p>
 
 <h3 id="examples">Examples</h3>
 
@@ -731,7 +731,7 @@ <h5>Inherited Members</h5>
                                         <input id="Feed.__init__-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
 <div class="attr function">
 
-        <span class="name">Feed</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="n">title</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param">	<span class="n">home_page_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">feed_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">user_comment</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">next_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">icon</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">favicon</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">author</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param">	<span class="n">authors</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n"><a href="#Author">jsonfeed.Author</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">expired</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>,</span><span class="param">	<span class="n">language</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">hubs</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n"><a href="#Hub">jsonfeed.Hub</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>,</span><span class="param">	<span class="n">items</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n"><a href="#Item">jsonfeed.Item</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span></span>)</span>
+        <span class="name">Feed</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="n">title</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param">	<span class="n">home_page_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">feed_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">user_comment</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">next_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">icon</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">favicon</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">author</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param">	<span class="n">authors</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n"><a href="#Author">jsonfeed.Author</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">expired</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>,</span><span class="param">	<span class="n">language</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">hubs</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n"><a href="#Hub">jsonfeed.Hub</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>,</span><span class="param">	<span class="n">items</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n"><a href="#Item">jsonfeed.Item</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span></span>)</span>
 
                 <label class="view-source-button" for="Feed.__init__-view-source"><span>View Source</span></label>
 
@@ -1134,7 +1134,7 @@ <h5>Inherited Members</h5>
                                         <input id="Item.__init__-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
 <div class="attr function">
 
-        <span class="name">Item</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="nb">id</span>,</span><span class="param">	<span class="n">url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">external_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">title</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">content_html</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">content_text</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">summary</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">image</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">banner_image</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">date_published</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">date_modified</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">author</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param">	<span class="n">authors</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n"><a href="#Author">jsonfeed.Author</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">tags</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>,</span><span class="param">	<span class="n">attachments</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n"><a href="#Attachment">jsonfeed.Attachment</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span></span>)</span>
+        <span class="name">Item</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="nb">id</span>,</span><span class="param">	<span class="n">url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">external_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">title</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">content_html</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">content_text</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">summary</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">image</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">banner_image</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">date_published</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">date_modified</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">author</span><span class="o">=</span><span class="kc">None</span>,</span><span class="param">	<span class="n">authors</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n"><a href="#Author">jsonfeed.Author</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param">	<span class="n">tags</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>,</span><span class="param">	<span class="n">attachments</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n"><a href="#Attachment">jsonfeed.Attachment</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span></span>)</span>
 
                 <label class="view-source-button" for="Item.__init__-view-source"><span>View Source</span></label>