From 82f8c75db9a244243f78857ff956cbacafa08dfe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Gmach?= Date: Mon, 29 Jun 2020 15:26:12 +0200 Subject: [PATCH] Show link to documentation in the README file modified: CHANGES.rst modified: README.rst --- CHANGES.rst | 3 ++- README.rst | 18 +++++++++++++----- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index ed9a4aa..105537a 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -9,7 +9,8 @@ unreleased * update docs/index.rst * use blue ReadTheDocs theme * update sphinx configuration - + * add documentation link to `setup.py`, so it shows on PyPi + * add note about documentation in the README file 0.3.1 diff --git a/README.rst b/README.rst index aac55be..33ead82 100644 --- a/README.rst +++ b/README.rst @@ -58,14 +58,22 @@ So, if you use `pip` to install your packages, instead of ... This means you do not have to change a single line of code. -Contributing +Installation ------------ -Contributions are more than welcome. Please have a look at -https://github.com/jugmac00/flask-reuploaded/issues + $ pip install Flask-Reuploaded -Installation +Documentation +------------- + +The documentation can be found at... + +https://flask-reuploaded.readthedocs.io/en/latest/ + + +Contributing ------------ - $ pip install Flask-Reuploaded +Contributions are more than welcome. Please have a look at +https://github.com/jugmac00/flask-reuploaded/issues