anime-downloader/docs/index.rst

62 lines
1.4 KiB
ReStructuredText

.. anime-downloader documentation master file, created by
sphinx-quickstart on Tue Oct 9 19:36:23 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Anime-Downloader's documentation!
============================================
Anime-Downloader helps you download your favorite anime
Features
--------
- Download or stream any episode or episode range of any anime.
- Specify the quality you want to stream or download.
- Search and download.
- Save yourselves from those malicious ads.
- Download using external downloader ([aria2](https://aria2.github.io/) recommended).
- Configurable using `config.json`. See [doc](https://github.com/vn-ki/anime-downloader/wiki/Config).
Supported Sites
---------------
- Animepahe
- Anistream
- Animeflix
- Animefreak
- Gogoanime
- Dubbedanime
- a2zanime
- animeout
- itsaturday
- Animeflv
- Kickassanime
- DreamAnime
- RyuAnime
- Erai-Raws
- Animesimple
- Animerush
- Watchmovie
- twist.moe - requires Node.js
- Kissanime - requires Node.js
- Kisscartoon - requires Node.js
NOTE: To download from sites marked `[cloudflare]`, anime-downloader has to be installed with cloudflare support(See below);
.. toctree::
:maxdepth: 2
:hidden:
:caption: Contents:
usage/installation
usage/dl
usage/test
usage/watch
usage/config
usage/sites
usage/api
advanced/custom_site
api/base_classes.rst
api/helper_functions.rst