big documentation update

Author: willforde

.gitignore

@@ -94,3 +94,5 @@ ENV/
 # Rope project settings
 .ropeproject
 .idea/
+docs/_static/
+script.module.codequick/.kodi/

docs/api/base.rst

@@ -0,0 +1,9 @@
+Base
+====
+
+.. autoclass:: codequick.script.Script
+   :members:
+
+.. autoclass:: codequick.script.Settings
+   :members:
+   :special-members: __getitem__, __setitem__

docs/api/index.rst

@@ -0,0 +1,19 @@
+API
+===
+
+fhfghfghfgh
+fdghfdghdfghdfgh
+dfg
+h
+fdgh
+dfghdfghfdghfdhgfdh
+
+ .. toctree::
+    :maxdepth: 1
+
+    base
+    route
+    resolver
+    listitem
+    storage
+    utils

docs/api/listitem.rst

@@ -0,0 +1,65 @@
+Listitem
+========
+The list item control is used for creating item lists in Kodi.
+
+.. autoclass:: codequick.listing.Listitem
+
+    .. attribute:: params
+
+        :class:`Params<codequick.listing.Params>` dictionary object for adding callback parameters.
+
+    .. attribute:: info
+
+        :class:`Info<codequick.listing.Info>` dictionary object for adding infoLabels.
+
+    .. attribute:: art
+
+        :class:`Art<codequick.listing.Art>` dictionary object for adding listitem art.
+
+    .. attribute:: stream
+
+        :class:`Stream<codequick.listing.Stream>` dictionary object for adding stream details.
+
+    .. attribute:: property
+
+        :class:`Property<codequick.listing.Property>` dictionary object for adding listitem properties.
+
+    .. attribute:: context
+
+        :class:`Context<codequick.listing.Context>` dictionary object for context menu items.
+
+    .. attribute:: listitem
+
+        The underlining kodi listitem object, for advanced use.
+
+    .. autoattribute:: codequick.listing.Listitem.label
+    .. automethod:: codequick.listing.Listitem.set_callback
+    .. automethod:: codequick.listing.Listitem.from_dict
+    .. automethod:: codequick.listing.Listitem.next_page
+    .. automethod:: codequick.listing.Listitem.youtube
+    .. automethod:: codequick.listing.Listitem.recent
+    .. automethod:: codequick.listing.Listitem.search
+
+
+.. autoclass:: codequick.listing.Params
+    :members:
+    :special-members: __getitem__, __setitem__
+
+.. autoclass:: codequick.listing.Art
+    :members:
+    :special-members: __getitem__, __setitem__
+
+.. autoclass:: codequick.listing.Info
+    :members:
+    :special-members: __getitem__, __setitem__
+
+.. autoclass:: codequick.listing.Property
+    :members:
+    :special-members: __getitem__, __setitem__
+
+.. autoclass:: codequick.listing.Stream
+    :members:
+    :special-members: __getitem__, __setitem__
+
+.. autoclass:: codequick.listing.Context
+    :members:

docs/api/resolver.rst

@@ -0,0 +1,5 @@
+Resolver
+========
+
+.. autoclass:: codequick.resolver.Resolver
+   :members:

docs/api/route.rst

@@ -0,0 +1,5 @@
+Route
+=====
+
+.. autoclass:: codequick.route.Route
+   :members:

docs/api/storage.rst

@@ -0,0 +1,17 @@
+Storage
+=======
+Persistent data storage objects. They will act like normal built-in data types,
+except all data will be saved to disk for later access when flushed.
+
+.. autoclass:: codequick.storage.PersistentDict
+    :members:
+
+    .. automethod:: codequick.storage.PersistentDict.flush
+    .. automethod:: codequick.storage.PersistentDict.close
+
+
+.. autoclass:: codequick.storage.PersistentList
+    :members:
+
+    .. automethod:: codequick.storage.PersistentList.flush
+    .. automethod:: codequick.storage.PersistentList.close

docs/api/utils.rst

@@ -0,0 +1,6 @@
+Utils
+=====
+A collection of useful function.
+
+.. automodule:: codequick.utils
+   :members:

docs/conf.py

@@ -12,13 +12,15 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
+from addondev import initializer
 import sys
 import os
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../script.module.codequick/lib'))
+initializer(os.path.abspath('../script.module.codequick'))
 
 
 # -- General configuration ------------------------------------------------
@@ -168,4 +170,4 @@
 ]
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/2', None)}

docs/index.rst

@@ -3,24 +3,17 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to CodeQuick's documentation!
-=====================================
+============
+Introduction
+============
+sdasdfasf asdf asfd asdf asdf asdf asdf asdf asdf
+
+Contents
+========
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
-
-.. autoclass:: codequick.script.Script
-   :members:
-
-.. autoclass:: codequick.script.Settings
-   :members:
-   :special-members: __getitem__, __setitem__
-
-
-Indices and tables
-==================
+   :titlesonly:
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   tutorial
+   api/index

docs/tutorial.rst

@@ -0,0 +1,9 @@
+########
+Tutorial
+########
+sdasdfasf asdf asfd asdf asdf asdf asdf asdf asdf
+ghjghjghjghj
+ghj
+gh
+jgh
+jghjgjh