Minor documentation tunings
This commit is contained in:
parent
d7b1e2002d
commit
90c5cc3c72
@ -339,6 +339,10 @@ get the current username of a profile, given this unique ID
|
||||
|
||||
.. as-module-intro-end
|
||||
|
||||
Refer to the
|
||||
`Instaloader Documentation <http://instaloader.readthedocs.io/>`__ for
|
||||
more information.
|
||||
|
||||
Disclaimer
|
||||
----------
|
||||
|
||||
|
7
docs/_templates/links.html
vendored
Normal file
7
docs/_templates/links.html
vendored
Normal file
@ -0,0 +1,7 @@
|
||||
<h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://github.com/Thammus/instaloader">Instaloader on GitHub</a></li>
|
||||
<li><a href="https://pypi.python.org/pypi/instaloader">Instaloader on PyPI</a></li>
|
||||
<li><a href="https://github.com/Thammus/instaloader/issues">Issue Tracker</a></li>
|
||||
<li><a href="https://github.com/Thammus/instaloader/releases">Version History</a></li>
|
||||
</ul>
|
@ -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.
|
||||
|
@ -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 <https://github.com/Thammus/instaloader>`__
|
||||
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) <https://github.com/Thammus/instaloader>`__
|
||||
- `PyPI Project Page <https://pypi.python.org/pypi/instaloader>`__
|
||||
- `Issue Tracker / Bug Tracker <https://github.com/Thammus/instaloader/issues>`__
|
||||
- `Version History <https://github.com/Thammus/instaloader/releases>`__
|
||||
|
||||
.. include:: ../README.rst
|
||||
:start-after: disclaimer-start
|
||||
:end-before: disclaimer-end
|
||||
|
Loading…
Reference in New Issue
Block a user