diff --git a/README.rst b/README.rst index 19e0357..82c7291 100644 --- a/README.rst +++ b/README.rst @@ -339,6 +339,10 @@ get the current username of a profile, given this unique ID .. as-module-intro-end +Refer to the +`Instaloader Documentation `__ for +more information. + Disclaimer ---------- diff --git a/docs/_templates/links.html b/docs/_templates/links.html new file mode 100644 index 0000000..6ee13a9 --- /dev/null +++ b/docs/_templates/links.html @@ -0,0 +1,7 @@ +

Links

+ diff --git a/docs/conf.py b/docs/conf.py index 830d2d7..1b30dd4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -123,7 +123,7 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -178,7 +178,7 @@ html_static_path = ['_static'] # Custom sidebar templates, maps document names to template names. # -html_sidebars = {'**': ["globaltoc.html", "relations.html"], 'index': [] } +html_sidebars = {'**': ["globaltoc.html", "relations.html", "links.html"] } # Additional templates that should be rendered to pages, maps page names to # template names. diff --git a/docs/index.rst b/docs/index.rst index 6d778f2..c494e89 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,31 @@ -.. Instaloader documentation master file, created by - sphinx-quickstart on Fri Aug 25 15:38:26 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +Instaloader +=========== -Instaloader Documentation -========================= +*Instaloader* is a tool to download pictures (or videos) along with +their captions and other metadata from Instagram. -**Table of Contents**: +:: + + $ pip3 install instaloader + + $ instaloader profile [profile ...] + +**Instaloader** + +- downloads **public and private profiles, hashtags, user stories, + feeds**, + +- downloads **comments, geotags, captions** of each post, + +- allows **fine-grained customization** of filters and where to store + downloaded media, + +- is free `Open Source `__ + software written in Python. + + +Table of Contents +----------------- .. toctree:: :maxdepth: 2 @@ -16,6 +35,14 @@ Instaloader Documentation cli-options as-module +Useful Links +------------ + +- `Git Repository (on GitHub) `__ +- `PyPI Project Page `__ +- `Issue Tracker / Bug Tracker `__ +- `Version History `__ + .. include:: ../README.rst :start-after: disclaimer-start :end-before: disclaimer-end