Alexander Graf
d0e2ac4388
docs/install: Suggest pre-release rather than git
2018-08-24 12:42:51 +02:00
Alexander Graf
b443cc6654
Minor doc fixes and improvements
2018-08-24 11:53:14 +02:00
André Koch-Kramer
584c69d93c
Update docs and docstrings concerning highlights
2018-08-24 00:23:19 +02:00
Alexander Graf
43f52198ff
Fix docs building and show Highlights inheritance
2018-08-23 22:19:08 +02:00
André Koch-Kramer
91d5d5f867
Add class and functions for downloading highlights
...
Requested in #162 .
2018-08-23 22:19:08 +02:00
Alexander Graf
0dcc912987
doc: Note new features with versionadded
2018-08-23 17:25:28 +02:00
Alexander Graf
180d398ad7
docs: Exclude sphinx-1.7.7 to fix travis build
2018-08-23 16:14:02 +02:00
Alexander Graf
b91e73b090
set docs font size to 16px
2018-08-23 14:44:37 +02:00
Alexander Graf
e388a1c966
--no-posts; Deprecate --{profile-pic,stories}-only
2018-08-20 16:29:14 +02:00
Alexander Graf
0f0ac13d72
reorder --help output
2018-08-20 14:27:58 +02:00
Alexander Graf
06b7edd6d5
--no-pictures flag to not download post pictures
...
Closes #131 .
2018-08-20 14:27:58 +02:00
Alexander Graf
5f57345f1b
"instaloader -- -SHORTCODE" to fetch single post
...
Closes #129 .
2018-08-20 14:27:58 +02:00
Alexander Graf
f7e6632f68
Document --tagged{,-only} in docs/cli-options.rst
2018-08-20 10:44:20 +02:00
AndCycle
9258b84695
Allow reading arguments from file
...
Squashed commit of the following (pr #161 ):
commit 58235a99b0
Author: AndCycle <andcycle@andcycle.idv.tw>
Date: Thu Aug 16 17:57:26 2018 +0800
doc: proper fix rst syntax
commit 6620e3583c
Author: AndCycle <andcycle@andcycle.idv.tw>
Date: Thu Aug 16 17:29:25 2018 +0800
doc: fix syntax
commit 7a048a3c04
Author: AndCycle <andcycle@andcycle.idv.tw>
Date: Thu Aug 16 17:09:26 2018 +0800
doc: add info about read args from file.
commit c4ceaf9636
Author: AndCycle <andcycle@andcycle.idv.tw>
Date: Thu Aug 16 17:05:07 2018 +0800
alter `fromfile_prefix_chars` to plus sign to avoid conflict.
commit d469b52b95
Author: AndCycle <andcycle@andcycle.idv.tw>
Date: Mon Aug 6 19:10:23 2018 +0800
* Allow reading arguments from file
function referenced from instagram-scraper,
which provide a convenient way to hide sensitive information.
2018-08-20 09:00:51 +02:00
Alexander Graf
998333b7cd
Revert "Mention IRC channel #instaloader on Freenode"
...
This reverts commit 8423e3bd00
. The channel did
not have as much activity as expected and an IRC channel does not work if there
are not at least a few people in it.
2018-08-07 19:57:10 +02:00
André Koch-Kramer
0ebb223214
Added BTC address to donations section
...
Motivated by #130 .
2018-07-23 23:36:46 +02:00
Alexander Graf
8423e3bd00
Mention IRC channel #instaloader on Freenode
2018-07-22 10:55:29 +02:00
Alexander Graf
3cb33603e5
doc: Use Instaloader brand colors for links
2018-07-09 21:32:18 +02:00
Alexander Graf
8211c9daf1
Documentation Improvements
...
- Fix Spelling
- codesnippets: Improve introduction texts; Write subsection about
metadata JSON files
2018-06-17 18:10:19 +02:00
Alexander Graf
4cf1ae847d
Mention donation option in doc
...
(Suggested by #130 )
2018-06-13 08:39:29 +02:00
Alexander Graf
45fe509ac4
doc: Link codesnippets in basic-usage
2018-06-04 12:06:41 +02:00
Alexander Graf
ae492ed68b
New doc section: codesnippets / Advanced Examples
...
Presents code examples that use the instaloader module for more advanced tasks
than what is possible with the Instaloader command line interface.
Presents #46 , #56 , #110 , #113 , #120 , #121 .
2018-06-04 11:57:28 +02:00
Alexander Graf
60d35a95df
docs: note that --stories-only @login is bad
...
Motivated by #112 , #118 .
2018-05-14 11:04:48 +02:00
Alexander Graf
d19dd2c9d4
Fix internal references in docs/as-module
...
Further, document all attributes that are referred to, and ensure that there
will be no broken references again by letting Travis call Sphinx with -W -n.
2018-05-14 10:46:04 +02:00
Alexander Graf
a3a09e1952
Very minor tweak to a paragraph in basic-usage.rst
2018-05-02 17:26:53 +02:00
Alexander Graf
2722da6ae4
Fix anon username from id (find renamed profile)
...
maybe related to #95 , #104 , 67ac8f3397
.
2018-05-01 13:11:40 +02:00
Alexander Graf
1469064176
Minor documentation tweaks
...
- Instaloader as Cronjob sections
- Many new internal links to ease navigation
2018-04-30 09:56:43 +02:00
Alexander Graf
dba74ab8d4
Minor documentation improvements
2018-04-29 16:41:24 +02:00
Alexander Graf
dd80ef484c
Improve formatting of basic-usage/what-to-download
2018-04-29 16:26:31 +02:00
Alexander Graf
6117e223a7
Describe Metadata Text Files Feature
2018-04-29 16:24:55 +02:00
Alexander Graf
7c76202f1c
Update documentation regarding v4 changes
...
as-module.rst: List how Post and Profile is created
Describe new filename specification logic
Update filter-posts section
2018-04-29 13:33:25 +02:00
Alexander Graf
d21fb4154e
fine-tune as-module.rst
2018-04-28 21:45:57 +02:00
Alexander Graf
7edc69454d
doc: Fix links to Instaloader classes
2018-04-28 19:50:14 +02:00
Alexander Graf
2c50972e08
Update as-module.rst and docstrings
2018-04-28 15:47:04 +02:00
Alexander Graf
b9ac40899d
Theme-related Documentation Enhancements
...
- Consistent background color in all types of codes
- Improve dd (list item) padding
- Link to Index in global TOC in navbar
- Briefly describe Instaloader in `index.html` title
- Remove page contents (navbartoc) in index, genindex and installation
- Link to new pypi.org rather than old pypi.python.org
2018-04-28 15:47:04 +02:00
Alexander Graf
7d2830b8b2
Have --storyitem-filter (--only-if for StoryItems)
2018-04-19 15:12:05 +02:00
Alexander Graf
59152214cf
Allow specification of what to write in txt files
2018-04-13 22:54:40 +02:00
Alexander Graf
df1cdb5d48
Remove now-unneeded Tristate
2018-04-13 19:07:23 +02:00
Alexander Graf
f0bebd0d96
Saving and reimporting of JSON files
...
Metadata JSON files are now created by default. They can later be given
as a target to redownload Posts, StoryItems or Profiles with new
settings.
2018-04-12 22:03:02 +02:00
Alexander Graf
235522dfd7
Merge branch 'master' into v4-dev
2018-03-31 15:06:39 +02:00
André Koch-Kramer
40a87761c9
Mention Windows standalone exe in documentation
2018-03-29 19:47:35 +02:00
Alexander Graf
d533c60824
doc: Switch to mobile-friendlier bootstrap theme
...
It seems to be better supported than Alabaster and is easier to be
configured to look good on both a phone and a desktop.
2018-03-28 19:39:58 +02:00
Alexander Graf
539273b963
make doc more mobile-friendly
2018-03-24 21:47:35 +01:00
Alexander Graf
36110c8727
Disable search engine indexing on old doc hoster
2018-03-24 12:37:24 +01:00
Alexander Graf
4a944fbbdb
doc: meta tag to redirect to new documentation URL
2018-03-24 11:32:53 +01:00
Alexander Graf
a492f0a6d1
Merge branch 'master' into v4-dev
2018-03-22 16:10:35 +01:00
Alexander Graf
6764cd961f
Tweak documentation description html meta tags
2018-03-22 16:07:19 +01:00
Alexander Graf
4a2e32790a
Minor documentation improvements
...
- List all __init__ methods in documentation
- Further describe purpose of Profile in its docstring
2018-03-18 17:19:22 +01:00
Alexander Graf
760688d9e6
Profile class abstracting profile structure
2018-03-18 16:31:32 +01:00
Alexander Graf
279de0a641
List all Exceptions in doc, fix name inconsistcies
2018-03-18 16:29:34 +01:00
André Koch-Kramer
b2f31e7782
Add awesome logo to README
...
Due to rst limitations, the heading "Instaloader" was added beside the
logo inside the png.
2018-03-14 23:08:04 +01:00
Alexander Graf
68d8f65cb9
Add logo in documentation sidebar
2018-03-14 22:14:24 +01:00
Alexander Graf
e97e4ecdc8
Further enhance logo
2018-03-14 19:41:20 +01:00
Alexander Graf
e77c998a94
Invent beautiful logo and use it as doc favicon
2018-03-14 19:09:24 +01:00
Alexander Graf
14e9cf435e
Fix download of saved posts
...
(was broken with commit 83b31175df
, due to
a slight modification of Instaloader.get_profile_metadata)
2018-03-14 08:41:48 +01:00
Alexander Graf
92114f9018
Add message on instaloader.rtfd.io that doc moved
2018-03-13 16:58:00 +01:00
Alexander Graf
5f34fca9e7
Merge branch 'v3.3-dev'
2018-03-13 16:22:37 +01:00
Alexander Graf
e97411a502
Mention :saved in all places of documentation
2018-03-13 15:36:27 +01:00
Alexander Graf
304cde64fe
Link to github pages doc hosting rather than rtd
2018-03-13 15:11:36 +01:00
Alexander Graf
4e57ac77f0
docs: Obtain current tag via git instead of gh api
2018-03-13 14:03:49 +01:00
André Koch-Kramer
de960b2b57
Mentione target :saved in README, docs and --help
2018-03-13 13:53:21 +01:00
Alexander Graf
9b60adeb45
Adjust github repo references
...
New repo URL: https://github.com/instaloader/instaloader
2018-03-13 13:29:44 +01:00
Alexander Graf
39bd7c55f6
doc: link next section at the end of each page
...
This makes it easier to go through the documentation and it
pushes readthedocs's advertising further apart from the
content.
2018-01-13 19:15:32 +01:00
Alexander Graf
1ca368fa45
Mention Arch+Gentoo pkgs in doc/install section
2018-01-07 22:08:51 +01:00
Alexander Graf
698ea51cb9
Add contribution guidelines to documentation
2018-01-07 17:26:35 +01:00
Alexander Graf
e6be0179b7
Support {date_utc} filename_pattern
...
{date_utc} encodes the post creation date in UTC rather than the
current local timezone, as {date} does.
This was proposed in #69 . Encoding the post creation date in
local time zone induces problems regarding --fast-update when the
time zone is changed.
2018-01-07 14:52:03 +01:00
Alexander Graf
5695bca9f3
Current version and release date in doc sidebar
2017-12-21 13:53:06 +01:00
Alexander Graf
75d9dda4ba
--no-video-thumbnails option
...
Closes #61 .
2017-12-14 19:16:39 +01:00
Alexander Graf
3daaa6fbbc
--no-profile-pic to disable profile pic download
...
(Suggested in #61 )
2017-12-14 15:55:53 +01:00
Alexander Graf
e24c6a2cad
Add description meta tags to documentation
2017-12-03 15:20:51 +01:00
Alexander Graf
01e549275e
doc: ownership verification tag
2017-11-17 10:06:53 +01:00
Alexander Graf
37780986fc
doc: Page intro improvements
...
The introductionary sections of as-module and cli-options have been
rewritten. Further, Instaloader's short-description is now included in
the sidebar.
2017-11-14 11:18:30 +01:00
André Koch-Kramer
9f34e3303e
Added basic usage to README and documentation
2017-11-10 18:55:52 +01:00
André Koch-Kramer
e9207f095f
Use Post class attributes in filename-pattern
...
- Added owner_id and mediaid to Post class properties.
- In case of not downloading stories, the attributes of the Post class
can now be used in filename-pattern, e.g. {post.owner_id} or {post.mediaid}.
Closes #53 .
2017-11-08 15:58:33 +01:00
Alexander Graf
7d5bf0e8df
Fix Documentation link in docs/README.md
2017-11-03 10:59:52 +01:00
Alexander Graf
bdf31864eb
Create docs/README.md
2017-11-03 10:46:50 +01:00
Alexander Graf
32388b884f
Fix typos in documentation and --help output
2017-10-30 18:38:03 +01:00
Alexander Graf
a1920b97a4
More control about connection retry mechanism
...
- If when retrying a failed connection ^C is hit, the retrying is
aborted,
- Option --max-connection-attempts to override default of how many
connection attempts should be made.
Closes #51 .
2017-09-29 16:09:15 +02:00
Alexander Graf
e0ed4cf16c
Save metadata JSON with --metadata-json
...
With --metadata-json, a JSON file for each post is created saving the
Post properties defined in instaloader.Post class, i.e. caption, number
of likes, people tagged in caption or the picture itself, etc.
This closes #33 and closes #47 .
2017-09-29 14:07:00 +02:00
Alexander Graf
9a72f85a0e
Documentation Enhancements
2017-09-08 10:35:38 +02:00
Alexander Graf
e143096140
Minor documentation fixes
2017-08-29 12:13:38 +02:00
Alexander Graf
5b5d540310
caption_hashtags property for only-if evaluation
...
caption_hashtags is a list of all hashtags that are mentioned in the
Post's caption. It allows to easily filter Posts that have multiple
hashtags, and as such fixes #24 .
Further, the documentation of --only-if has been completed by linking to
a description of the syntax in the Python documentation, and by linking
to a list of all defined properties with their meanings. So, this commit
also closes #42 .
2017-08-29 11:03:12 +02:00
Alexander Graf
d84136b2dd
Minor doc-related improvements
2017-08-28 21:45:43 +02:00
Alexander Graf
e748b53b6a
Add layout template extension
...
(forgot to commit it. Sorry...)
2017-08-26 13:49:54 +02:00
Alexander Graf
5aff8273b0
Minor tweaks to documentation
2017-08-26 12:42:04 +02:00
Alexander Graf
1f89dba702
Minor Sphinx theme switch
...
(The links sidebar was not shown on readthedocs.io)
2017-08-25 22:46:36 +02:00
Alexander Graf
90c5cc3c72
Minor documentation tunings
2017-08-25 22:38:54 +02:00
Alexander Graf
d7b1e2002d
Avoid unicode character in docs/conf.py
...
(caused problems on readthedocs)
2017-08-25 19:41:35 +02:00
Alexander Graf
ec2e09edcf
Create minimal documentation with Sphinx
2017-08-25 16:54:36 +02:00