Skip to content
This repository has been archived by the owner on May 4, 2024. It is now read-only.

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@SamR1
SamR1 committed Jan 20, 2020
1 parent 937b708 commit 790de46
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 52 deletions.
35 changes: 19 additions & 16 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Changelog

## Version 0.1.8 (2020/01/xx)
## Version 0.1.8 (2020/01/20)

### Issues Closed

#### New Features

* [Issue 17](https://github.com/SamR1/rdltr/issues/17) - Display number of articles for each category and tag
* [#18](https://github.com/SamR1/rdltr/issues/18) - improve navigation
* [#17](https://github.com/SamR1/rdltr/issues/17) - display number of articles for each category and tag
* [ae01c14](https://github.com/SamR1/rdltr/commit/ae01c14b8d4e59644d47ac17e9c93d0097155c3e),
[8427384](https://github.com/SamR1/rdltr/commit/8427384158205c0358eb33be5396ec60e7d360b5) - improve tag filtering

In this release 1 issue was closed.
In this release 2 issue were closed.


## Version 0.1.7 (2020/01/15)
Expand All @@ -17,11 +20,11 @@ In this release 1 issue was closed.

#### New Features

* [Issue 15](https://github.com/SamR1/rdltr/issues/15) - improve documentation
* [#15](https://github.com/SamR1/rdltr/issues/15) - improve documentation

#### Bugs Fixed

* [Issue 16](https://github.com/SamR1/rdltr/issues/16) - cannot get favorite articles anymore
* [#16](https://github.com/SamR1/rdltr/issues/16) - cannot get favorite articles anymore

In this release 2 issue were closed.

Expand All @@ -32,7 +35,7 @@ In this release 2 issue were closed.

#### New Features

* [Issue 8](https://github.com/SamR1/rdltr/issues/8) - Scrape from browser DOM
* [#8](https://github.com/SamR1/rdltr/issues/8) - Scrape from browser DOM

In this release 1 issue was closed.

Expand All @@ -43,12 +46,12 @@ In this release 1 issue was closed.

#### New Features

* [Issue 13](https://github.com/SamR1/rdltr/issues/13) - add an article via a share link
* [Issue 12](https://github.com/SamR1/rdltr/issues/12) - add redirection after login
* [#13](https://github.com/SamR1/rdltr/issues/13) - add an article via a share link
* [#12](https://github.com/SamR1/rdltr/issues/12) - add redirection after login

#### Bugs Fixed

* [Issue 14](https://github.com/SamR1/rdltr/issues/14) - some articles still have encoding issues
* [#14](https://github.com/SamR1/rdltr/issues/14) - some articles still have encoding issues

In this release 3 issues were closed.

Expand All @@ -59,12 +62,12 @@ In this release 3 issues were closed.

#### New Features

* [Issue 4](https://github.com/SamR1/rdltr/issues/4) - add favorites
* [Issue 3](https://github.com/SamR1/rdltr/issues/3) - add a confirmation before deleting an article
* [#4](https://github.com/SamR1/rdltr/issues/4) - add favorites
* [#3](https://github.com/SamR1/rdltr/issues/3) - add a confirmation before deleting an article

#### Bugs Fixed

* [Issue 11](https://github.com/SamR1/rdltr/issues/11) - incorrect encoding on some articles
* [#11](https://github.com/SamR1/rdltr/issues/11) - incorrect encoding on some articles

In this release 3 issues were closed.

Expand All @@ -75,12 +78,12 @@ In this release 3 issues were closed.

#### New Features

* [Issue 7](https://github.com/SamR1/rdltr/issues/7) - add possibility to reload an article
* [#7](https://github.com/SamR1/rdltr/issues/7) - add possibility to reload an article

#### Bugs Fixed

* [Issue 5](https://github.com/SamR1/rdltr/issues/5) - some articles can't be downloaded
* [Issue 2](https://github.com/SamR1/rdltr/issues/2) - can't access the second page when filtering on a tag
* [#5](https://github.com/SamR1/rdltr/issues/5) - some articles can't be downloaded
* [#2](https://github.com/SamR1/rdltr/issues/2) - can't access the second page when filtering on a tag

In this release 3 issues were closed.

Expand All @@ -89,7 +92,7 @@ In this release 3 issues were closed.

#### Bugs Fixed

* [Issue 1](https://github.com/SamR1/rdltr/issues/1) - API URL can't be changed
* [#1](https://github.com/SamR1/rdltr/issues/1) - API URL can't be changed

In this release 1 issue was closed.

Expand Down
Binary file modified docs/_images/screenshot.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 19 additions & 16 deletions docs/_sources/changelog.md.txt
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Changelog

## Version 0.1.8 (2020/01/xx)
## Version 0.1.8 (2020/01/20)

### Issues Closed

#### New Features

* [Issue 17](https://github.com/SamR1/rdltr/issues/17) - Display number of articles for each category and tag
* [#18](https://github.com/SamR1/rdltr/issues/18) - improve navigation
* [#17](https://github.com/SamR1/rdltr/issues/17) - display number of articles for each category and tag
* [ae01c14](https://github.com/SamR1/rdltr/commit/ae01c14b8d4e59644d47ac17e9c93d0097155c3e),
[8427384](https://github.com/SamR1/rdltr/commit/8427384158205c0358eb33be5396ec60e7d360b5) - improve tag filtering

In this release 1 issue was closed.
In this release 2 issue were closed.


## Version 0.1.7 (2020/01/15)
Expand All @@ -17,11 +20,11 @@ In this release 1 issue was closed.

#### New Features

* [Issue 15](https://github.com/SamR1/rdltr/issues/15) - improve documentation
* [#15](https://github.com/SamR1/rdltr/issues/15) - improve documentation

#### Bugs Fixed

* [Issue 16](https://github.com/SamR1/rdltr/issues/16) - cannot get favorite articles anymore
* [#16](https://github.com/SamR1/rdltr/issues/16) - cannot get favorite articles anymore

In this release 2 issue were closed.

Expand All @@ -32,7 +35,7 @@ In this release 2 issue were closed.

#### New Features

* [Issue 8](https://github.com/SamR1/rdltr/issues/8) - Scrape from browser DOM
* [#8](https://github.com/SamR1/rdltr/issues/8) - Scrape from browser DOM

In this release 1 issue was closed.

Expand All @@ -43,12 +46,12 @@ In this release 1 issue was closed.

#### New Features

* [Issue 13](https://github.com/SamR1/rdltr/issues/13) - add an article via a share link
* [Issue 12](https://github.com/SamR1/rdltr/issues/12) - add redirection after login
* [#13](https://github.com/SamR1/rdltr/issues/13) - add an article via a share link
* [#12](https://github.com/SamR1/rdltr/issues/12) - add redirection after login

#### Bugs Fixed

* [Issue 14](https://github.com/SamR1/rdltr/issues/14) - some articles still have encoding issues
* [#14](https://github.com/SamR1/rdltr/issues/14) - some articles still have encoding issues

In this release 3 issues were closed.

Expand All @@ -59,12 +62,12 @@ In this release 3 issues were closed.

#### New Features

* [Issue 4](https://github.com/SamR1/rdltr/issues/4) - add favorites
* [Issue 3](https://github.com/SamR1/rdltr/issues/3) - add a confirmation before deleting an article
* [#4](https://github.com/SamR1/rdltr/issues/4) - add favorites
* [#3](https://github.com/SamR1/rdltr/issues/3) - add a confirmation before deleting an article

#### Bugs Fixed

* [Issue 11](https://github.com/SamR1/rdltr/issues/11) - incorrect encoding on some articles
* [#11](https://github.com/SamR1/rdltr/issues/11) - incorrect encoding on some articles

In this release 3 issues were closed.

Expand All @@ -75,12 +78,12 @@ In this release 3 issues were closed.

#### New Features

* [Issue 7](https://github.com/SamR1/rdltr/issues/7) - add possibility to reload an article
* [#7](https://github.com/SamR1/rdltr/issues/7) - add possibility to reload an article

#### Bugs Fixed

* [Issue 5](https://github.com/SamR1/rdltr/issues/5) - some articles can't be downloaded
* [Issue 2](https://github.com/SamR1/rdltr/issues/2) - can't access the second page when filtering on a tag
* [#5](https://github.com/SamR1/rdltr/issues/5) - some articles can't be downloaded
* [#2](https://github.com/SamR1/rdltr/issues/2) - can't access the second page when filtering on a tag

In this release 3 issues were closed.

Expand All @@ -89,7 +92,7 @@ In this release 3 issues were closed.

#### Bugs Fixed

* [Issue 1](https://github.com/SamR1/rdltr/issues/1) - API URL can't be changed
* [#1](https://github.com/SamR1/rdltr/issues/1) - API URL can't be changed

In this release 1 issue was closed.

Expand Down
39 changes: 21 additions & 18 deletions docs/changelog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#version-0-1-8-2020-01-xx">Version 0.1.8 (2020/01/xx)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#version-0-1-8-2020-01-20">Version 0.1.8 (2020/01/20)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#issues-closed">Issues Closed</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#new-features">New Features</a></li>
</ul>
Expand Down Expand Up @@ -214,16 +214,19 @@

<div class="section" id="changelog">
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline"></a></h1>
<div class="section" id="version-0-1-8-2020-01-xx">
<h2>Version 0.1.8 (2020/01/xx)<a class="headerlink" href="#version-0-1-8-2020-01-xx" title="Permalink to this headline"></a></h2>
<div class="section" id="version-0-1-8-2020-01-20">
<h2>Version 0.1.8 (2020/01/20)<a class="headerlink" href="#version-0-1-8-2020-01-20" title="Permalink to this headline"></a></h2>
<div class="section" id="issues-closed">
<h3>Issues Closed<a class="headerlink" href="#issues-closed" title="Permalink to this headline"></a></h3>
<div class="section" id="new-features">
<h4>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/17">Issue 17</a> - Display number of articles for each category and tag</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/18">#18</a> - improve navigation</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/17">#17</a> - display number of articles for each category and tag</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/commit/ae01c14b8d4e59644d47ac17e9c93d0097155c3e">ae01c14</a>,
<a class="reference external" href="https://github.com/SamR1/rdltr/commit/8427384158205c0358eb33be5396ec60e7d360b5">8427384</a> - improve tag filtering</p></li>
</ul>
<p>In this release 1 issue was closed.</p>
<p>In this release 2 issue were closed.</p>
</div>
</div>
</div>
Expand All @@ -234,13 +237,13 @@ <h3>Issues Closed<a class="headerlink" href="#id1" title="Permalink to this head
<div class="section" id="id2">
<h4>New Features<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/15">Issue 15</a> - improve documentation</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/15">#15</a> - improve documentation</p></li>
</ul>
</div>
<div class="section" id="bugs-fixed">
<h4>Bugs Fixed<a class="headerlink" href="#bugs-fixed" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/16">Issue 16</a> - cannot get favorite articles anymore</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/16">#16</a> - cannot get favorite articles anymore</p></li>
</ul>
<p>In this release 2 issue were closed.</p>
</div>
Expand All @@ -253,7 +256,7 @@ <h3>Issues Closed<a class="headerlink" href="#id3" title="Permalink to this head
<div class="section" id="id4">
<h4>New Features<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/8">Issue 8</a> - Scrape from browser DOM</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/8">#8</a> - Scrape from browser DOM</p></li>
</ul>
<p>In this release 1 issue was closed.</p>
</div>
Expand All @@ -266,14 +269,14 @@ <h3>Issues Closed<a class="headerlink" href="#id5" title="Permalink to this head
<div class="section" id="id6">
<h4>New Features<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/13">Issue 13</a> - add an article via a share link</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/12">Issue 12</a> - add redirection after login</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/13">#13</a> - add an article via a share link</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/12">#12</a> - add redirection after login</p></li>
</ul>
</div>
<div class="section" id="id7">
<h4>Bugs Fixed<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/14">Issue 14</a> - some articles still have encoding issues</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/14">#14</a> - some articles still have encoding issues</p></li>
</ul>
<p>In this release 3 issues were closed.</p>
</div>
Expand All @@ -286,14 +289,14 @@ <h3>Issues Closed<a class="headerlink" href="#id8" title="Permalink to this head
<div class="section" id="id9">
<h4>New Features<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/4">Issue 4</a> - add favorites</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/3">Issue 3</a> - add a confirmation before deleting an article</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/4">#4</a> - add favorites</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/3">#3</a> - add a confirmation before deleting an article</p></li>
</ul>
</div>
<div class="section" id="id10">
<h4>Bugs Fixed<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/11">Issue 11</a> - incorrect encoding on some articles</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/11">#11</a> - incorrect encoding on some articles</p></li>
</ul>
<p>In this release 3 issues were closed.</p>
</div>
Expand All @@ -306,14 +309,14 @@ <h3>Issues Closed<a class="headerlink" href="#id11" title="Permalink to this hea
<div class="section" id="id12">
<h4>New Features<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/7">Issue 7</a> - add possibility to reload an article</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/7">#7</a> - add possibility to reload an article</p></li>
</ul>
</div>
<div class="section" id="id13">
<h4>Bugs Fixed<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/5">Issue 5</a> - some articles can’t be downloaded</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/2">Issue 2</a> - can’t access the second page when filtering on a tag</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/5">#5</a> - some articles can’t be downloaded</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/2">#2</a> - can’t access the second page when filtering on a tag</p></li>
</ul>
<p>In this release 3 issues were closed.</p>
</div>
Expand All @@ -324,7 +327,7 @@ <h2>Version 0.1.2 (2019/03/31)<a class="headerlink" href="#version-0-1-2-2019-03
<div class="section" id="id14">
<h3>Bugs Fixed<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/1">Issue 1</a> - API URL can’t be changed</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/1">#1</a> - API URL can’t be changed</p></li>
</ul>
<p>In this release 1 issue was closed.</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ <h1>Welcome to rdltr’s documentation!<a class="headerlink" href="#welcome-to-r
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-8-2020-01-xx">Version 0.1.8 (2020/01/xx)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-8-2020-01-20">Version 0.1.8 (2020/01/20)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-7-2020-01-15">Version 0.1.7 (2020/01/15)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-6-2020-01-10">Version 0.1.6 (2020/01/10)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-5-2019-12-25">Version 0.1.5 (2019/12/25)</a></li>
Expand Down
Loading

0 comments on commit 790de46

Please sign in to comment.