fix documentation

Author: Ferdinand E. Silva

pastebin_python/pastebin.py

@@ -1,5 +1,5 @@
 """
-.. module:: pastebin
+.. module:: pastebin_python.pastebin
    :synopsis: This module contains the main class to be instantiated to use pastebin.com functionality
 
 .. moduleauthor:: Ferdinand Silva <[email protected]>
@@ -23,7 +23,7 @@ def __init__(self, **kwargs):
 		
 		:param kwargs: keyword arguments to set settings that can be use to call pastebin.com API function
 		:type kwargs: dict
-		:returns: class -- PastebinPython
+		:returns: class -- :class:`pastebin_python.pastebin.PastebinPython`
 
 		===========
 		Example:
@@ -41,7 +41,7 @@ def __init__(self, **kwargs):
 
 	@property
 	def api_user_key(self):
-		"""This is where the api_user_key is stored after calling :func:`createAPIUserKey`
+		"""This is where the api_user_key is stored after calling :meth:`pastebin_python.pastebin.createAPIUserKey`
 
 		:returns: str -- the api_user_key
 
@@ -50,7 +50,7 @@ def api_user_key(self):
 
 	@property
 	def api_user_paste_list(self):
-		"""This where the list of pastes of the current user is stored after calling :func:`listUserPastes`
+		"""This where the list of pastes of the current user is stored after calling :meth:`pastebin_python.pastebin.listUserPastes`
 
 		:returns: list -- current user pastes list
 
@@ -71,7 +71,7 @@ def createPaste(self, api_paste_code, api_paste_name='', api_paste_format='', ap
 		:param api_paste_expire_date: this sets the expiration date of your paste, values to be assign can be found at :mod:`pastebin_python.pastebin_constants`
 		:type api_paste_expire_date: str
 		:returns: str -- pastebin.com paste URL
-		:raises: PastebinBadRequestException
+		:raises: :exc:`pastebin_python.pastebin_exceptions.PastebinBadRequestException`
 
 		.. note::
 
@@ -94,7 +94,7 @@ def createPaste(self, api_paste_code, api_paste_name='', api_paste_format='', ap
 		return self.__processPost(PASTEBIN_API_POST_URL, postData)
 
 	def createPasteFromFile(self, filename, api_paste_name='', api_paste_format='', api_paste_private='', api_paste_expire_date=''):
-		"""Almost the same as :func:`createPaste` ,the only difference is that the value of *api_paste_code* came from the file you opened 
+		"""Almost the same as :meth:`pastebin_python.pastebin.createPaste` ,the only difference is that the value of *api_paste_code* came from the file you opened 
 		
 		:param filename: the full path of the file
 		:type filename: str
@@ -107,7 +107,7 @@ def createPasteFromFile(self, filename, api_paste_name='', api_paste_format='',
 		:param api_paste_expire_date: this sets the expiration date of your paste, values to be assign can be found at :mod:`pastebin_python.pastebin_constants`
 		:type api_paste_expire_date: str
 		:returns: str -- pastebin.com paste URL
-		:raises: PastebinFileException
+		:raises: :exc:`pastebin_python.pastebin_exceptions.PastebinFileException`
 
 		.. note::
 
@@ -131,9 +131,9 @@ def __processPost(self, url, data):
 		:param url: the url of the pastebin.com **API**
 		:type url: str
 		:param data: the data to be POSTed to the pastebin.com **API**
-		:type data: dic
+		:type data: dict
 		:returns: str -- the successfull output of the pastebin.com **API** if no exception raised
-		:raises: PastebinBadRequestException, PastebinNoPastesException
+		:raises: :exc:`pastebin_python.pastebin_exceptions.PastebinBadRequestException`, :exc:`pastebin_python.pastebin_exceptions.PastebinNoPastesException`
 
 		"""
 
@@ -156,7 +156,7 @@ def createAPIUserKey(self, api_user_name, api_user_password):
 		:param api_user_password: this is the pastebin.com password
 		:type api_user_password: str
 		:returns: str -- unique user session key
-		:raises: PastebinBadRequestException
+		:raises: :exc:`pastebin_python.pastebin_exceptions.PastebinBadRequestException`
 
 		.. note::
 
@@ -180,11 +180,11 @@ def listUserPastes(self, api_results_limit=50):
 		:param api_results_limit: this is not required but the min value should be 1 and the max value should be 1000
 		:type api_results_limit: int
 		:returns: list -- the list of of pastes in a dictionary type
-		:raises: PastebinBadRequestException, PastebinNoPastesException
+		:raises: :exc:`pastebin_python.pastebin_exceptions.PastebinBadRequestException`, :exc:`pastebin_python.pastebin_exceptions.PastebinNoPastesException`
 
 		.. note::
 
-			Need to call the :func:`createAPIUserKey` first before calling this function
+			Need to call the :meth:`pastebin_python.pastebin.createAPIUserKey` first before calling this function
 			Pastes list will be stored to the private variable *__api_user_paste_list* and can be retrieve by the property *api_user_key*
 
 		"""
@@ -205,7 +205,7 @@ def listTrendingPastes(self):
 		"""This will list the 18 currently trending pastes
 
 		:returns: list -- the 18 currently trending pastes in a dictionary format
-		:raises: PastebinBadRequestException
+		:raises: :exc:`pastebin_python.pastebin_exceptions.PastebinBadRequestException`
 
 		"""
 
@@ -222,7 +222,7 @@ def listTrendingPastes(self):
 	def __parseUser(self, xmlString):
 		"""This will parse the xml string returned by the function :func:`getUserInfos`
 
-		:param xmlString: this is the returned xml string from :func:`getUserInfos`
+		:param xmlString: this is the returned xml string from :meth:`pastebin_python.pastebin.getUserInfos`
 		:type xmlString: str
 		:returns: list -- user info in a dictionary format
 
@@ -247,7 +247,7 @@ def __parseUser(self, xmlString):
 	def __parsePaste(self, xmlString):
 		"""This will parse the xml string returned by the the function :func:`listUserPastes` or :func:`listTrendingPastes`
 
-		:param xmlString: this is the returned xml string from :func:`listUserPastes` or :func:`listTrendingPastes`
+		:param xmlString: this is the returned xml string from :meth:`pastebin_python.pastebin.listUserPastes` or :meth:`pastebin_python.pastebin.listTrendingPastes`
 		:type xmlString: str
 		:returns: list -- pastes info in a dictionary format
 
@@ -302,13 +302,13 @@ def __parseXML(self, xml, isPaste=True):
 	def deletePaste(self, api_paste_key):
 		"""This will delete pastes created by certain users
 
-		:param api_paste_key: this is the paste key that which you can get in the :func:`listUserPastes` function
+		:param api_paste_key: this is the paste key that which you can get in the :meth:`pastebin_python.pastebin.listUserPastes` function
 		:type api_paste_key: str
 		:returns: bool -- True if the deletion is successfull else False
 
 		.. note::
 
-			Before calling this function, you need to call the :func:`createAPIUserKey` first then call the :func:`listUserPastes`
+			Before calling this function, you need to call the :meth:`pastebin_python.pastebin.createAPIUserKey` first then call the :meth:`pastebin_python.pastebin.listUserPastes`
 
 		"""
 		postData = {
@@ -333,11 +333,11 @@ def getUserInfos(self):
 		"""You can obtain a users personal info and certain settings by calling this function
 
 		:returns: list -- user info in a dictionary format
-		:raises: PastebinBadRequestException
+		:raises: :exc:`pastebin_python.pastebin_exceptions.PastebinBadRequestException`
 
 		.. note::
 
-			You need to call the :func:`createAPIUserKey` before calling this function
+			You need to call the :meth:`pastebin_python.pastebin.createAPIUserKey` before calling this function
 
 		"""
 

pastebin_python/pastebin_constants.py

@@ -1,6 +1,6 @@
 """
-.. module:: pastebin_constants
-	:synopsis: This module contains the constants that can be used in the :func:`pastebin_python.pastebin.PastebinPython.__processPost` , :func:`pastebin_python.pastebin.PastebinPython.createPaste` and :func:`pastebin_python.pastebin.PastebinPython.createPasteFromFile`
+.. module:: pastebin_python.pastebin_constants
+	:synopsis: This module contains the constants that can be used in the :meth:`pastebin_python.pastebin.PastebinPython.__processPost` , :meth:`pastebin_python.pastebin.PastebinPython.createPaste` and :meth:`pastebin_python.pastebin.PastebinPython.createPasteFromFile`
 
 .. moduleauthor:: Ferdinand Silva <[email protected]>
 

pastebin_python/pastebin_exceptions.py

@@ -1,5 +1,5 @@
 """
-.. module:: pastebin_exceptions
+.. module:: pastebin_python.pastebin_exceptions
 	:synopsis: This module contains all of the exceptions
 
 .. moduleauthor:: Ferdinand Silva <[email protected]>

pastebin_python/pastebin_formats.py

@@ -1,6 +1,6 @@
 """
-.. module:: pastebin_formats
-	:synopsis: This module contains constants that can be used in :func:`pastebin_python.pastebin.PastebinPython.createPaste` or :func:`pastebin_python.pastebin.PastebinPython.createPasteFromFile` in *api_paste_format* parameter
+.. module:: pastebin_python.pastebin_formats
+	:synopsis: This module contains constants that can be used in :meth:`pastebin_python.pastebin.PastebinPython.createPaste` or :meth:`pastebin_python.pastebin.PastebinPython.createPasteFromFile` in *api_paste_format* parameter
 
 .. moduleauthor:: Ferdinand Silva <[email protected]>
 

pastebin_python/pastebin_options.py

@@ -1,5 +1,5 @@
 """
-.. module:: pastebin_options
+.. module:: pastebin_python.pastebin_options
 	:synopsis: This module contains constants that can be used in *api_option*
 
 .. moduleauthor:: Ferdinand Silva <[email protected]>