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

Commit 790de46

Browse files
SamR1SamR1
committed
update documentation
1 parent 937b708 commit 790de46

File tree

7 files changed

+61
-52
lines changed

7 files changed

+61
-52
lines changed

‎CHANGELOG.md

+19-16
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Changelog
22

3-
## Version 0.1.8 (2020/01/xx)
3+
## Version 0.1.8 (2020/01/20)
44

55
### Issues Closed
66

77
#### New Features
88

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

11-
In this release 1 issue was closed.
14+
In this release 2 issue were closed.
1215

1316

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

1821
#### New Features
1922

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

2225
#### Bugs Fixed
2326

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

2629
In this release 2 issue were closed.
2730

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

3336
#### New Features
3437

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

3740
In this release 1 issue was closed.
3841

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

4447
#### New Features
4548

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

4952
#### Bugs Fixed
5053

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

5356
In this release 3 issues were closed.
5457

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

6063
#### New Features
6164

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

6568
#### Bugs Fixed
6669

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

6972
In this release 3 issues were closed.
7073

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

7679
#### New Features
7780

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

8083
#### Bugs Fixed
8184

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

8588
In this release 3 issues were closed.
8689

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

9093
#### Bugs Fixed
9194

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

9497
In this release 1 issue was closed.
9598

‎docs/_images/screenshot.png

18.1 KB
Loading

‎docs/_sources/changelog.md.txt

+19-16
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Changelog
22

3-
## Version 0.1.8 (2020/01/xx)
3+
## Version 0.1.8 (2020/01/20)
44

55
### Issues Closed
66

77
#### New Features
88

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

11-
In this release 1 issue was closed.
14+
In this release 2 issue were closed.
1215

1316

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

1821
#### New Features
1922

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

2225
#### Bugs Fixed
2326

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

2629
In this release 2 issue were closed.
2730

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

3336
#### New Features
3437

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

3740
In this release 1 issue was closed.
3841

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

4447
#### New Features
4548

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

4952
#### Bugs Fixed
5053

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

5356
In this release 3 issues were closed.
5457

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

6063
#### New Features
6164

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

6568
#### Bugs Fixed
6669

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

6972
In this release 3 issues were closed.
7073

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

7679
#### New Features
7780

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

8083
#### Bugs Fixed
8184

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

8588
In this release 3 issues were closed.
8689

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

9093
#### Bugs Fixed
9194

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

9497
In this release 1 issue was closed.
9598

‎docs/changelog.html

+21-18
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a></li>
9292
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
9393
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
94-
<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>
94+
<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>
9595
<li class="toctree-l3"><a class="reference internal" href="#issues-closed">Issues Closed</a><ul>
9696
<li class="toctree-l4"><a class="reference internal" href="#new-features">New Features</a></li>
9797
</ul>
@@ -214,16 +214,19 @@
214214

215215
<div class="section" id="changelog">
216216
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline"></a></h1>
217-
<div class="section" id="version-0-1-8-2020-01-xx">
218-
<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>
217+
<div class="section" id="version-0-1-8-2020-01-20">
218+
<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>
219219
<div class="section" id="issues-closed">
220220
<h3>Issues Closed<a class="headerlink" href="#issues-closed" title="Permalink to this headline"></a></h3>
221221
<div class="section" id="new-features">
222222
<h4>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h4>
223223
<ul class="simple">
224-
<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>
224+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/18">#18</a> - improve navigation</p></li>
225+
<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>
226+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/commit/ae01c14b8d4e59644d47ac17e9c93d0097155c3e">ae01c14</a>,
227+
<a class="reference external" href="https://github.com/SamR1/rdltr/commit/8427384158205c0358eb33be5396ec60e7d360b5">8427384</a> - improve tag filtering</p></li>
225228
</ul>
226-
<p>In this release 1 issue was closed.</p>
229+
<p>In this release 2 issue were closed.</p>
227230
</div>
228231
</div>
229232
</div>
@@ -234,13 +237,13 @@ <h3>Issues Closed<a class="headerlink" href="#id1" title="Permalink to this head
234237
<div class="section" id="id2">
235238
<h4>New Features<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h4>
236239
<ul class="simple">
237-
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/15">Issue 15</a> - improve documentation</p></li>
240+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/15">#15</a> - improve documentation</p></li>
238241
</ul>
239242
</div>
240243
<div class="section" id="bugs-fixed">
241244
<h4>Bugs Fixed<a class="headerlink" href="#bugs-fixed" title="Permalink to this headline"></a></h4>
242245
<ul class="simple">
243-
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/16">Issue 16</a> - cannot get favorite articles anymore</p></li>
246+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/16">#16</a> - cannot get favorite articles anymore</p></li>
244247
</ul>
245248
<p>In this release 2 issue were closed.</p>
246249
</div>
@@ -253,7 +256,7 @@ <h3>Issues Closed<a class="headerlink" href="#id3" title="Permalink to this head
253256
<div class="section" id="id4">
254257
<h4>New Features<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h4>
255258
<ul class="simple">
256-
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/8">Issue 8</a> - Scrape from browser DOM</p></li>
259+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/8">#8</a> - Scrape from browser DOM</p></li>
257260
</ul>
258261
<p>In this release 1 issue was closed.</p>
259262
</div>
@@ -266,14 +269,14 @@ <h3>Issues Closed<a class="headerlink" href="#id5" title="Permalink to this head
266269
<div class="section" id="id6">
267270
<h4>New Features<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h4>
268271
<ul class="simple">
269-
<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>
270-
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/12">Issue 12</a> - add redirection after login</p></li>
272+
<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>
273+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/12">#12</a> - add redirection after login</p></li>
271274
</ul>
272275
</div>
273276
<div class="section" id="id7">
274277
<h4>Bugs Fixed<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h4>
275278
<ul class="simple">
276-
<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>
279+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/14">#14</a> - some articles still have encoding issues</p></li>
277280
</ul>
278281
<p>In this release 3 issues were closed.</p>
279282
</div>
@@ -286,14 +289,14 @@ <h3>Issues Closed<a class="headerlink" href="#id8" title="Permalink to this head
286289
<div class="section" id="id9">
287290
<h4>New Features<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h4>
288291
<ul class="simple">
289-
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/4">Issue 4</a> - add favorites</p></li>
290-
<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>
292+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/4">#4</a> - add favorites</p></li>
293+
<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>
291294
</ul>
292295
</div>
293296
<div class="section" id="id10">
294297
<h4>Bugs Fixed<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h4>
295298
<ul class="simple">
296-
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/11">Issue 11</a> - incorrect encoding on some articles</p></li>
299+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/11">#11</a> - incorrect encoding on some articles</p></li>
297300
</ul>
298301
<p>In this release 3 issues were closed.</p>
299302
</div>
@@ -306,14 +309,14 @@ <h3>Issues Closed<a class="headerlink" href="#id11" title="Permalink to this hea
306309
<div class="section" id="id12">
307310
<h4>New Features<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h4>
308311
<ul class="simple">
309-
<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>
312+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/7">#7</a> - add possibility to reload an article</p></li>
310313
</ul>
311314
</div>
312315
<div class="section" id="id13">
313316
<h4>Bugs Fixed<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h4>
314317
<ul class="simple">
315-
<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>
316-
<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>
318+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/5">#5</a> - some articles can’t be downloaded</p></li>
319+
<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>
317320
</ul>
318321
<p>In this release 3 issues were closed.</p>
319322
</div>
@@ -324,7 +327,7 @@ <h2>Version 0.1.2 (2019/03/31)<a class="headerlink" href="#version-0-1-2-2019-03
324327
<div class="section" id="id14">
325328
<h3>Bugs Fixed<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h3>
326329
<ul class="simple">
327-
<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>
330+
<li><p><a class="reference external" href="https://github.com/SamR1/rdltr/issues/1">#1</a> - API URL can’t be changed</p></li>
328331
</ul>
329332
<p>In this release 1 issue was closed.</p>
330333
</div>

‎docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ <h1>Welcome to rdltr’s documentation!<a class="headerlink" href="#welcome-to-r
183183
</ul>
184184
</li>
185185
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
186-
<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>
186+
<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>
187187
<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>
188188
<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>
189189
<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>

0 commit comments

Comments
 (0)