instaloader/docs/README.md

# Instaloader Documentation

This directory contains sources for the Instaloader documentation.

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

## Build

The documentation is created with [Sphinx](http://www.sphinx-doc.org/). To build it, use

```
pip3 install sphinx sphinx-autodoc-typehints
make html
```
Create docs/README.md 2017-11-03 10:46:50 +01:00			`# Instaloader Documentation`

			`This directory contains sources for the Instaloader documentation.`

			`The documentation is hosted at:`
Fix Documentation link in docs/README.md 2017-11-03 10:59:52 +01:00			`https://instaloader.readthedocs.io/`
Create docs/README.md 2017-11-03 10:46:50 +01:00
			`## Build`

			`The documentation is created with [Sphinx](http://www.sphinx-doc.org/). To build it, use`

			```
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			`pip3 install sphinx sphinx-autodoc-typehints`
Create docs/README.md 2017-11-03 10:46:50 +01:00			`make html`
			```