Merge pull request #2 from lehinevych/docs

Docs

README.rst

@@ -2,11 +2,8 @@ MediaWikiAPI
 ===================
 
 <!---
-.. image:: https://travis-ci.org/goldsmith/Wikipedia.png?branch=master
-  :target: https://travis-ci.org/goldsmith/Wikipedia
-.. image:: https://pypip.in/license/wikiapi/badge.png
-  :target: https://pypi.python.org/pypi/wikiapi/
-  :alt: License
+.. image:: https://travis-ci.org/lehinevych/MediaWikiAPI.svg?branch=master
+  :target: https://travis-ci.org/leginevych/MediaWikiAPI
 --->
 
 
@@ -51,15 +48,12 @@ To install MediaWikiAPI, simply run:
 
   $ pip install mediawikiapi
 
-MediaWikiAPI is compatible with Python 2.6+ (2.7+ to run unittest discover) and Python 3.3+.
+MediaWikiAPI is compatible only with Python 3.3+. Support for Python 2.7 will be added soon.
 
 Documentation
 -------------
 
-Read the docs at https://wikiapi.readthedocs.org/en/latest/.
-
--  `Quickstart <https://wikiapi.readthedocs.org/en/latest/quickstart.html>`__
--  `Full API <https://wikiapi.readthedocs.org/en/latest/code.html>`__
+Soon will be available on readthedocs.
 
 To run tests, clone the `repository on GitHub <https://github.com/lehinevych/MediaWikiAPI>`__, then run:
 

docs/source/_themes/flask_small/theme.conf

@@ -7,4 +7,4 @@ pygments_style = flask_theme_support.FlaskyStyle
 [options]
 index_logo = ''
 index_logo_height = 120px
-github_fork = goldsmith/Wikipedia
+github_fork = lehinevych/MediaWikiAPI

docs/source/code.rst

@@ -1,9 +1,9 @@
 .. _api:
 
-Wikipedia Documentation
+MediaWikiAPI Documentation
 ***********************
 
-Here you can find the full developer API for the wikipedia project.
+Here you can find the full developer API for the MediaWikiAPI project.
 
 Contents:
 
@@ -17,7 +17,7 @@ Contents:
 Functions and Classes
 ===============================
 
-.. automodule:: wikipedia
+.. automodule:: mediawikiapi
 
   .. autofunction:: search(query, results=10, suggestion=False)
 
@@ -29,23 +29,23 @@ Functions and Classes
 
   .. autofunction:: geosearch(latitude, longitude, title=None, results=10, radius=1000)
 
-.. autoclass:: wikipedia.WikipediaPage
+.. autoclass:: mediawikiapi.WikipediaPage
   :members:
 
-.. autofunction:: wikipedia.languages
+.. autofunction:: mediawikiapi.languages
 
-.. autofunction:: wikipedia.set_lang
+.. autofunction:: mediawikiapi.set_lang
 
-.. autofunction:: wikipedia.set_rate_limiting
+.. autofunction:: mediawikiapi.config.set_rate_limiting
 
-.. autofunction:: wikipedia.random
+.. autofunction:: mediawikiapi.random
 
-.. autofunction:: wikipedia.donate
+.. autofunction:: mediawikiapi.donate
 
 Exceptions
 ==========
 
-.. automodule:: wikipedia.exceptions
+.. automodule:: mediawikiapi.exceptions
   :members:
 
 Indices and tables

docs/source/index.rst

@@ -1,20 +1,20 @@
 .. _index:
 
-WikipediaAPI
+MediaWikiAPI
 ============
 
-WikipediaAPI
+MediaWikiAPI
 ************
 
-WikipediaAPI is a Python library that makes it easy to access and parse data from Wikipedia.
+MediaWikiAPI is a Python library that makes it easy to access and parse data from Wikipedia.
 
 Search Wikipedia, get article summaries, get data like links and images from a page, and more. Wikipedia wraps the `MediaWiki API <https://www.mediawiki.org/wiki/API>`_ so you can focus on using Wikipedia data, not getting it.
 
 ::
 
-	>>> import wikipedia
+	>>> import mediawikiapi
 
-	>>> print wikipedia.summary("Wikipedia")
+	>>> print mediawikiapi.summary("Wikipedia")
 	# Wikipedia (/ˌwɪkɨˈpiːdiə/ or /ˌwɪkiˈpiːdiə/ WIK-i-PEE-dee-ə) is a collaboratively edited, multilingual, free Internet encyclopedia supported by the non-profit Wikimedia Foundation...
 
 Go to the :ref:`quickstart` to start using ``wikipedia`` now, or see the :ref:`api`.