From 5aff8273b0d4d424918b8679a53abdb60fb2f063 Mon Sep 17 00:00:00 2001 From: Alexander Graf Date: Sat, 26 Aug 2017 12:42:04 +0200 Subject: [PATCH] Minor tweaks to documentation --- README.rst | 5 ++++- docs/_templates/links.html | 15 +++++++++++++-- docs/basic-usage.rst | 4 ++-- docs/index.rst | 4 +++- instaloader.py | 4 +++- setup.py | 5 ++++- 6 files changed, 29 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 82c7291..dc26c11 100644 --- a/README.rst +++ b/README.rst @@ -32,6 +32,9 @@ will be installed automatically, if it is not already installed. How to Automatically Download Pictures from Instagram ----------------------------------------------------- +(This file is only a summary of +`the complete Instaloader Documentation `__) + .. basic-usage-start To **download all pictures and videos of a profile**, as well as the @@ -340,7 +343,7 @@ get the current username of a profile, given this unique ID .. as-module-intro-end Refer to the -`Instaloader Documentation `__ for +`Instaloader Documentation `__ for more information. Disclaimer diff --git a/docs/_templates/links.html b/docs/_templates/links.html index 6ee13a9..77ac94e 100644 --- a/docs/_templates/links.html +++ b/docs/_templates/links.html @@ -1,7 +1,18 @@ +{% if next %} +

Next

+ +{% endif %}

Links

+ diff --git a/docs/basic-usage.rst b/docs/basic-usage.rst index ab8d50c..fe1f9bb 100644 --- a/docs/basic-usage.rst +++ b/docs/basic-usage.rst @@ -1,5 +1,5 @@ -How to Download Pictures from Instagram ---------------------------------------- +Download Pictures from Instagram +--------------------------------- Basic Usage ^^^^^^^^^^^ diff --git a/docs/index.rst b/docs/index.rst index c494e89..2f58362 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,9 +1,11 @@ Instaloader =========== -*Instaloader* is a tool to download pictures (or videos) along with +**Instaloader** is a tool to download pictures (or videos) along with their captions and other metadata from Instagram. +With `Python `__ installed, do: + :: $ pip3 install instaloader diff --git a/instaloader.py b/instaloader.py index 6006f7d..ac19b53 100755 --- a/instaloader.py +++ b/instaloader.py @@ -1302,7 +1302,9 @@ class Instaloader: def main(): parser = ArgumentParser(description=__doc__, add_help=False, - epilog="Report issues at https://github.com/Thammus/instaloader/issues.") + epilog="Report issues at https://github.com/Thammus/instaloader/issues. " + "The complete documentation can be found at " + "https://instaloader.readthedocs.io/.") g_what = parser.add_argument_group('What to Download', 'Specify a list of profiles or #hashtags. For each of these, Instaloader ' diff --git a/setup.py b/setup.py index 248fccb..ec51090 100755 --- a/setup.py +++ b/setup.py @@ -31,11 +31,14 @@ keywords = (['instagram', 'instagram-scraper', 'instagram-client', 'instagram-fe 'pictures', 'instagram-user-photos', 'instagram-photos', 'instagram-metadata', 'instagram-downloader', 'instagram-stories']) +# NOTE that many of the values defined in this file are duplicated on other places, such as the +# documentation. + setup( name='instaloader', version=get_version(), py_modules=['instaloader'], - url='https://github.com/Thammus/instaloader', + url='https://instaloader.readthedocs.io/', license='MIT', author='Alexander Graf, André Koch-Kramer', author_email='mail@agraf.me, koch-kramer@web.de',