Docs fixes

weibeu · May 9, 2019 · bf49390 · bf49390
1 parent 53fed2b
commit bf49390
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 49 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -7,34 +7,34 @@ attributes and available methods.
 Discord OAuth2 Client
 ---------------------
 
-.. autoclass:: flask_discord.DiscordOAuth2Session()
+.. autoclass:: flask_discord.DiscordOAuth2Session
     :members:
     :inherited-members:
 
-.. autoclass:: flask_discord._http.DiscordOAuth2HttpClient()
+.. autoclass:: flask_discord._http.DiscordOAuth2HttpClient
     :members:
     :inherited-members:
 
 
 Models
 ------
 
-.. autoclass:: flask_discord.models.Guild()
+.. autoclass:: flask_discord.models.Guild
     :members:
     :inherited-members:
 
-.. autoclass:: flask_discord.models.User()
+.. autoclass:: flask_discord.models.User
     :members:
     :inherited-members:
 
-.. autoclass:: flask_discord.models.Bot()
+.. autoclass:: flask_discord.models.Bot
     :members:
     :inherited-members:
 
-.. autoclass:: flask_discord.models.Integration()
+.. autoclass:: flask_discord.models.Integration
     :members:
     :inherited-members:
 
-.. autoclass:: flask_discord.models.UserConnection()
+.. autoclass:: flask_discord.models.UserConnection
     :members:
     :inherited-members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -39,6 +39,9 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
     'pallets_sphinx_themes',
 ]
 

diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -14,24 +14,24 @@ permissions.
 Requirements
 ------------
 
-This extensions requires ``Flask`` installed. Python version can be chosen
-as per ``Flask`` requirements.
+- **Flask**
+    This is an Flask extension.
 
-It also requires another library ``requests_oauthlib`` to create OAuth2 sessions
-to discord.
+- **requests_oauthlib**
+    It also requires requests_oauthlib to make OAuth2 sessions with discord.
 
 Installing
 ----------
 
 You can install Flask-Discord directly from PyPI using PIP and following command
 in shell or command prompt: ::
 
-	python3 -m pip install -U Flask-Discord
+    python3 -m pip install -U Flask-Discord
 
 You can also install the latest development version (**maybe unstable/broken**) by
 using following command: ::
 
-	python3 -m pip install -U git+https://github.com/thec0sm0s/Flask-Discord.git
+    python3 -m pip install -U git+https://github.com/thec0sm0s/Flask-Discord.git@dev
 
 
 Basic Usage
@@ -42,44 +42,44 @@ in exchange for fetching user's details and display them on web page.
 
 .. code-block:: python3
 
-	from flask import Flask, redirect, url_for
-	from flask_discord import DiscordOAuth2Session
+    from flask import Flask, redirect, url_for
+    from flask_discord import DiscordOAuth2Session
 
-	CONFIGS = {
-		"client_id": 9999999999,
-		"client_secret": "your client secret",
-		"redirect_uri": "default redirect uri",
-	}
+    CONFIGS = {
+        "client_id": 9999999999,
+        "client_secret": "your client secret",
+        "redirect_uri": "default redirect uri",
+    }
 
-	app = Flask(__name__)
-	app.secret_key = "random bytes representing flask secret key"
-	discord = DiscordOAuth2Session(**CONFIGS)
+    app = Flask(__name__)
+    app.secret_key = "random bytes representing flask secret key"
+    discord = DiscordOAuth2Session(**CONFIGS)
 
 
-	@app.route("/login")
-	def login():
-		return discord.create_session()
+    @app.route("/login")
+    def login():
+        return discord.create_session()
 
 
-	@app.route("/callback")
-	def callback():
-		discord.callback()
-		return redirect(url_for(".me"))
+    @app.route("/callback")
+    def callback():
+        discord.callback()
+        return redirect(url_for(".me"))
 
 
-	@app.route("/me")
-	def me():
-		user = discord.fetch_user()
-		return f"""
-			<html>
-			<head>
-				<title>{user.name}</title>
-			</head>
-			<body>
-				<img src='{user.avatar_url}' />
-			</body>
-			</html>
-			"""
+    @app.route("/me")
+    def me():
+        user = discord.fetch_user()
+        return f"""
+        <html>
+            <head>
+                <title>{user.name}</title>
+            </head>
+            <body>
+                <img src='{user.avatar_url}' />
+            </body>
+        </html>"""
 
-	if __name__ == "__main__":
-		app.run()
+
+    if __name__ == "__main__":
+        app.run()
diff --git a/flask_discord/_http.py b/flask_discord/_http.py
@@ -9,7 +9,8 @@
 
 class DiscordOAuth2HttpClient(abc.ABC):
     """An OAuth2 http abstract base class providing some factory methods.
-    This class is meant to be overridden by flask_discord.DiscordOAuth2Session class.
+    This class is meant to be overridden by :py:class:`flask_discord.DiscordOAuth2Session`
+     and should not be used directly.
 
     Attributes
     ----------
@@ -75,8 +76,7 @@ def get(self, route: str) -> dict:
         Parameters
         ----------
         route : str
-            Route or endpoint URL to send HTTP GET request to.
-            Example: ``/users/@me``
+            Route or endpoint URL to send HTTP GET request to. Example: ``/users/@me``
 
         Returns
         -------

diff --git a/flask_discord/client.py b/flask_discord/client.py
@@ -7,7 +7,7 @@ class DiscordOAuth2Session(_http.DiscordOAuth2HttpClient):
     """Main client class representing hypothetical OAuth2 session with discord.
     It uses Flask `session <http://flask.pocoo.org/docs/1.0/api/#flask.session>`_ local proxy object
     to save state, authorization token and keeps record of users sessions across different requests.
-    This class inherits flask_discord._http.DiscordOAuth2HttpClient class which
+    This class inherits :py:class:`flask_discord._http.DiscordOAuth2HttpClient` class.
 
     Parameters
     ----------