instaloader/docs
sushilicious 30555b576c Added commit mode
The commit mode ensures pictures are not corrupted when Instaloader is
unexpectedly interrupted. In the case that the last picture is corrupted
because of an interruption, Instaloader will redownload the picture.
Since the metadata is the last object saved to disk, we can consider a
post as "committed" if its json metadata file exists and is not
malformed. Instaloader should download any posts which are not
committed. Downside is commit mode requires metadata to be saved.
2018-12-09 02:12:45 -05:00
..
_static Minor doc fixes and improvements 2018-08-24 11:53:14 +02:00
_templates Mention donation option in doc 2018-06-13 08:39:29 +02:00
codesnippets docs/codesnippets: Link to source tree on github 2018-08-30 09:18:58 +02:00
.gitignore Create minimal documentation with Sphinx 2017-08-25 16:54:36 +02:00
as-module.rst Minor doc fixes and improvements 2018-08-24 11:53:14 +02:00
basic-usage.rst Merge branch 'v4.1-dev' 2018-09-02 21:56:16 +02:00
cli-options.rst Added commit mode 2018-12-09 02:12:45 -05:00
codesnippets.rst docs/codesnippets: Link to source tree on github 2018-08-30 09:18:58 +02:00
conf.py New doc section: codesnippets / Advanced Examples 2018-06-04 11:57:28 +02:00
contributing.rst Revert "Mention IRC channel #instaloader on Freenode" 2018-08-07 19:57:10 +02:00
favicon.ico Further enhance logo 2018-03-14 19:41:20 +01:00
index.rst Minor doc fixes and improvements 2018-08-24 11:53:14 +02:00
installation.rst docs/install: Suggest pre-release rather than git 2018-08-24 12:42:51 +02:00
logo_heading.png Add awesome logo to README 2018-03-14 23:08:04 +01:00
logo.png Add logo in documentation sidebar 2018-03-14 22:14:24 +01:00
logo.svg Further enhance logo 2018-03-14 19:41:20 +01:00
Makefile Add logo in documentation sidebar 2018-03-14 22:14:24 +01:00
README.md Link to github pages doc hosting rather than rtd 2018-03-13 15:11:36 +01:00
requirements.txt docs: Exclude sphinx-1.7.7 to fix travis build 2018-08-23 16:14:02 +02:00
sphinx_autodoc_typehints.py doc: Fix links to Instaloader classes 2018-04-28 19:50:14 +02:00

Instaloader Documentation

This directory contains sources for the Instaloader documentation.

The documentation is hosted at: https://instaloader.github.io/

Build

The documentation is created with Sphinx. To build it, use

pip3 install -r requirements.txt
make html