update docs

thundergolfer · Apr 23, 2018 · 20d4bff · 20d4bff
1 parent b939959
commit 20d4bff
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 2 deletions.
diff --git a/docs/about.rst.inc b/docs/about.rst.inc
@@ -0,0 +1,23 @@
+**politifact-py** is an API wrapper for the Politifact public REST API.
+
+.. code-block:: python
+  from politifact import Politifact
+
+  p = Politifact()
+  obama_related = p.statements().people('Barack Obama')
+
+  for statement in obama_related:
+    print(statement.ruling)
+
+  # OUTPUT:
+  # > True
+  # > Pants On Fire!
+  # > Mostly True
+  # > ...
+
+Get It Now
+==========
+
+.. code-block:: bash
+
+    $ pip install politifact
diff --git a/docs/api_references.rst b/docs/api_references.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,14 +3,23 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Politifact-Py's documentation!
-=========================================
+ ********************************************
+ politifact-py: Politifact REST API Wrapper
+ ********************************************
+
+ Release v\ |version|. (:ref:`Changelog <changelog>`)
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+ API Reference
+ =============
+
+ .. toctree::
+     :maxdepth: 2
 
+     api_reference
 
 Indices and tables
 ==================