add docs

Pipfile

@@ -7,3 +7,5 @@ name = "pypi"
 anime-downloader = {editable = true, path = "."}
 
 [dev-packages]
+sphinx = "*"
+sphinx-rtd-theme = "*"

anime_downloader/sites/anime.py

@@ -1,3 +1,6 @@
+"""
+anime.py contains the base classes required for other anime classes.
+"""
 import requests
 from bs4 import BeautifulSoup
 
@@ -13,7 +16,31 @@
 from anime_downloader.extractors import get_extractor
 from anime_downloader.downloader import get_downloader
 
+
 class BaseAnime:
+    """
+    Base class for all anime classes.
+
+    Parameters
+    ----------
+    url: string
+        URL of the anime.
+    quality: One of ['360p', '480p', '720p', '1080p']
+        Quality of episodes
+    fallback_qualities: list
+        The order of fallback.
+
+    Attributes
+    ----------
+    sitename: string
+        name of the site
+    title: string
+        Title of the anime
+    meta: dict
+        metadata about the anime. [Can be empty]
+    QUALITIES: list
+        Possible qualities for the site
+    """
     sitename = ''
     title = ''
     meta = dict()
@@ -23,6 +50,12 @@ class BaseAnime:
 
     @classmethod
     def search(cls, query):
+        """
+        Search searches for the anime using the query given.
+
+        query :
+            query is
+        """
         return
 
     def __init__(self, url=None, quality='720p',

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/advanced/custom_site.rst

@@ -0,0 +1,3 @@
+Writing your own custom site class
+**********************************
+

docs/api/anime.rst

@@ -0,0 +1,7 @@
+Base classes
+************
+
+.. automodule:: anime_downloader.sites.anime
+
+.. autoclass:: anime_downloader.sites.anime.BaseAnime
+   :members: search