Skip to content

Commit

Permalink
update docs;
Browse files Browse the repository at this point in the history
  • Loading branch information
twiddli committed Sep 24, 2017
1 parent 443874f commit 3b96c7a
Show file tree
Hide file tree
Showing 17 changed files with 14 additions and 12 deletions.
Binary file modified docs/.doctrees/api.doctree
Binary file not shown.
Binary file modified docs/.doctrees/api_general.doctree
Binary file not shown.
Binary file modified docs/.doctrees/api_plugin.doctree
Binary file not shown.
Binary file modified docs/.doctrees/client.doctree
Binary file not shown.
Binary file modified docs/.doctrees/env.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/.doctrees/install.doctree
Binary file not shown.
Binary file modified docs/.doctrees/plugin.doctree
Binary file not shown.
Binary file modified docs/.doctrees/settings.doctree
Binary file not shown.
Binary file modified docs/.doctrees/switches.doctree
Binary file not shown.
Binary file modified docs/.doctrees/todo.doctree
Binary file not shown.
Binary file modified docs/.doctrees/usage.doctree
Binary file not shown.
11 changes: 6 additions & 5 deletions docs/_sources/api_general.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Hierarchy

.. note::

**Grouping** is actually not a direct descendant of **Collection** as can be seen below,
**Grouping** is not actually a direct descendant of **Collection** as can be seen below,
but it is sometimes helpful to think of it as such.

Recommended Usage
Expand All @@ -36,8 +36,8 @@ GalleryFilter
***************************************

Think of this as those *smart-playlists* in music applications. It's a compilation of galleries put
together by the user either manually or through automatic search filtering. If you used the old
Happypanda then you should already be familiar with this. In old HP they were called gallery lists.
together by the user either manually or through automatic search filtering. If you've used the old
Happypanda then you've should already be familiar with this. In old HP they were called gallery lists.
Recommended usage is "anything". It could range from your favorite fetishes to a shortcut for a
search filter you're tired of always typing in.

Expand All @@ -54,13 +54,14 @@ Gallery

- A **Gallery** can have multiple **Title**, **Artist** and **Parody**
- A **Gallery** can be in multiple **Collection** and **GalleryFilter**
- A **Gallery** can only be in *one* **Grouping**
- A **Gallery** can only be in **one** **Grouping**
- A **Gallery** will *always* be in a **Grouping**

Tags
***************************************

**Gallery** and **Page** are the only taggable items.
**Collection** and **Grouping** are *not* taggable, but they can display tags for all the containing **Gallery**.
**Collection** and **Grouping** are *not* taggable, but they can display, and are searchable through tags of their children **Gallery**.

Alias
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
11 changes: 6 additions & 5 deletions docs/api_general.html
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ <h3>Hierarchy<a class="headerlink" href="#hierarchy" title="Permalink to this he
<p><strong>Collection</strong> -&gt; <strong>Grouping</strong> -&gt; <strong>Gallery</strong> -&gt; <strong>Page</strong></p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><strong>Grouping</strong> is actually not a direct descendant of <strong>Collection</strong> as can be seen below,
<p class="last"><strong>Grouping</strong> is not actually a direct descendant of <strong>Collection</strong> as can be seen below,
but it is sometimes helpful to think of it as such.</p>
</div>
</div>
Expand All @@ -224,8 +224,8 @@ <h4>Grouping<a class="headerlink" href="#grouping" title="Permalink to this head
<div class="section" id="galleryfilter">
<h4>GalleryFilter<a class="headerlink" href="#galleryfilter" title="Permalink to this headline"></a></h4>
<p>Think of this as those <em>smart-playlists</em> in music applications. It&#8217;s a compilation of galleries put
together by the user either manually or through automatic search filtering. If you used the old
Happypanda then you should already be familiar with this. In old HP they were called gallery lists.
together by the user either manually or through automatic search filtering. If you&#8217;ve used the old
Happypanda then you&#8217;ve should already be familiar with this. In old HP they were called gallery lists.
Recommended usage is &#8220;anything&#8221;. It could range from your favorite fetishes to a shortcut for a
search filter you&#8217;re tired of always typing in.</p>
</div>
Expand All @@ -241,13 +241,14 @@ <h4>Gallery<a class="headerlink" href="#id1" title="Permalink to this headline">
<ul class="simple">
<li>A <strong>Gallery</strong> can have multiple <strong>Title</strong>, <strong>Artist</strong> and <strong>Parody</strong></li>
<li>A <strong>Gallery</strong> can be in multiple <strong>Collection</strong> and <strong>GalleryFilter</strong></li>
<li>A <strong>Gallery</strong> can only be in <em>one</em> <strong>Grouping</strong></li>
<li>A <strong>Gallery</strong> can only be in <strong>one</strong> <strong>Grouping</strong></li>
<li>A <strong>Gallery</strong> will <em>always</em> be in a <strong>Grouping</strong></li>
</ul>
</div>
<div class="section" id="tags">
<h4>Tags<a class="headerlink" href="#tags" title="Permalink to this headline"></a></h4>
<p><strong>Gallery</strong> and <strong>Page</strong> are the only taggable items.
<strong>Collection</strong> and <strong>Grouping</strong> are <em>not</em> taggable, but they can display tags for all the containing <strong>Gallery</strong>.</p>
<strong>Collection</strong> and <strong>Grouping</strong> are <em>not</em> taggable, but they can display, and are searchable through tags of their children <strong>Gallery</strong>.</p>
<div class="section" id="alias">
<h5>Alias<a class="headerlink" href="#alias" title="Permalink to this headline"></a></h5>
<blockquote>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/settings.html
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ <h1>Settings<a class="headerlink" href="#settings" title="Permalink to this head
<td>A secret key to be used for security. Keep it secret!</td>
</tr>
<tr class="row-odd"><td>server_name</td>
<td>happypanda_HQqr9Z4</td>
<td>happypanda_r6ro-NI</td>
<td>Specifiy name of the server</td>
</tr>
<tr class="row-even"><td>port</td>
Expand Down

0 comments on commit 3b96c7a

Please sign in to comment.