Documentation updated.

Author: Paul Hallett

HISTORY.rst

@@ -3,7 +3,9 @@
 History
 -------
 
-0.0.1 (2013-11-11)
+0.0.1 (2013-12-23)
 ++++++++++++++++++
 
-* First release on PyPI.
+* First release on PyPI.
+* All PokeAPI resources fully supported and represented in an object-oriented style.
+* Easy-to-use API: just one method!

README.rst

@@ -8,9 +8,6 @@ Pykemon
 .. image:: https://travis-ci.org/phalt/pykemon.png?branch=master
         :target: https://travis-ci.org/phalt/pykemon
 
-.. image:: https://pypip.in/d/pykemon/badge.png
-        :target: https://crate.io/packages/pykemon?version=latest
-
 A python wrapper for `PokeAPI <http://pokeapi.co>`_
 
 * Free software: BSD license
@@ -39,27 +36,13 @@ Even simpler:
     <Pokemon - Bulbasaur>
     >>> p = pykemon.get(pokemon_id=1)
     <Pokemon - Bulbasaur>
-
-Interact with resources linked to Pokemon easily:
-
-.. code-block:: python
-
-    >>> p.moves
-    ['cut', 'tackle', 'vine whip']
-    >>> p.get_move('cut')
-    <Move - cut>
-
-Or grab a resource separately:
-
-.. code-block:: python
-
-    >>> pykemon.get(move='cut')
+    >>> pykemon.get(move_id=15)
     <Move - cut>
 
 
 Features
 --------
 
-* Generate objects from PokeAPI resources.
+* Generate Python objects from PokeAPI resources.
 
 * Human-friendly API

docs/conf.py

@@ -243,8 +243,8 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
   ('index', 'pykemon', u'Pykemon Documentation',
-   u'Paul Hallett', 'pykemon', 'One line description of project.',
-   'Miscellaneous'),
+   u'Paul Hallett', 'pykemon', 'Python wrapper for PokeAPI.co.',
+   'Wrapper'),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -257,4 +257,6 @@
 #texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+#texinfo_no_detailmenu = False
+
+RTD_NEW_THEME = True

docs/modules.rst

@@ -0,0 +1,7 @@
+pykemon
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   pykemon

docs/pykemon.rst

@@ -0,0 +1,46 @@
+pykemon package
+===============
+
+Submodules
+----------
+
+pykemon.api module
+------------------
+
+.. automodule:: pykemon.api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pykemon.exceptions module
+-------------------------
+
+.. automodule:: pykemon.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pykemon.models module
+---------------------
+
+.. automodule:: pykemon.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pykemon.request module
+----------------------
+
+.. automodule:: pykemon.request
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pykemon
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/usage.rst

@@ -4,4 +4,57 @@ Usage
 
 To use Pykemon in a project::
 
-	import pykemon
+>>> import pykemon
+
+Then you can start grabbing stuff from the API::
+
+    >>> pykemon.get(pokemon='mew')
+    <Pokemon - Mew>
+    >>> pykemon.get(pokemon_id=1)
+    <Pokemon - Bulbasaur>
+
+Fully supports all the resources on PokeAPI::
+
+    >>> pykemon.get(move_id=15)
+    <Move - Cut>
+    >>> pykemon.get(ability_id=1)
+    <Ability - stench>
+
+Resources that have other abilities linked are displayed as dicts::
+
+    >>> p = pykemon.get(pokemon_id=1)
+    >>> p
+    <Pokemon - Bulbasaur>
+    >>> p.evolutions
+    {'Ivysaur': '/api/v1/pokemon/2/'}
+
+With the resource uri information you can request the linked resources easily.
+
+
+=====
+Options
+====
+
+Each resource is accessible, with it's own object-oriented representation.
+Every resource can be accessed with the term::
+
+    resource_id
+
+Where 'resource' is replaced depending on the resource you want::
+
+    pokemon_id
+    move_id
+    ability_id
+    egg_id
+    type_id
+    description_id
+    game_id
+    sprite_id
+
+The Pokemon resource can also be requested using the name:
+
+    >>> pykemon.get(pokemon='rotom')
+    <Pokemon - Rotom>
+
+Make sure you use lower case strings!
+