Use code blocks for examples

httpx_oauth/clients/facebook.py

@@ -68,7 +68,9 @@ async def get_long_lived_access_token(self, token: str) -> OAuth2Token:
             the long-lived access token.
 
         Examples:
-            >>> long_lived_access_token = await client.get_long_lived_access_token("TOKEN")
+            ```py
+            long_lived_access_token = await client.get_long_lived_access_token("TOKEN")
+            ```
         """
         async with self.get_httpx_client() as client:
             request, auth = self.build_request(

httpx_oauth/clients/github.py

@@ -77,7 +77,9 @@ async def refresh_token(self, refresh_token: str):
             RefreshTokenNotSupportedError: The provider does not support token refresh.
 
         Examples:
-            >>> access_token = await client.refresh_token("REFRESH_TOKEN")
+            ```py
+            access_token = await client.refresh_token("REFRESH_TOKEN")
+            ```
         """
         assert self.refresh_token_endpoint is not None
         async with self.get_httpx_client() as client:
@@ -129,7 +131,9 @@ async def get_id_email(self, token: str) -> Tuple[str, Optional[str]]:
                 An error occurred while getting the id and email.
 
         Examples:
-            >>> user_id, user_email = await client.get_id_email("TOKEN")
+            ```py
+            user_id, user_email = await client.get_id_email("TOKEN")
+            ```
         """
         async with httpx.AsyncClient(
             headers={**self.request_headers, "Authorization": f"token {token}"}

httpx_oauth/clients/linkedin.py

@@ -68,7 +68,9 @@ async def refresh_token(self, refresh_token: str) -> OAuth2Token:
             RefreshTokenNotSupportedError: The provider does not support token refresh.
 
         Examples:
-            >>> access_token = await client.refresh_token("REFRESH_TOKEN")
+            ```py
+            access_token = await client.refresh_token("REFRESH_TOKEN")
+            ```
         """
         return await super().refresh_token(refresh_token)
 

httpx_oauth/clients/openid.py

@@ -42,8 +42,11 @@ def __init__(
                 An error occurred while fetching the OpenID configuration.
 
         Examples:
-            >>> from httpx_oauth.clients.openid import OpenID
-            >>> client = OpenID("CLIENT_ID", "CLIENT_SECRET", "https://example.fief.dev/.well-known/openid-configuration")
+            ```py
+            from httpx_oauth.clients.openid import OpenID
+
+            client = OpenID("CLIENT_ID", "CLIENT_SECRET", "https://example.fief.dev/.well-known/openid-configuration")
+            ``
         """
         with httpx.Client() as client:
             try:

httpx_oauth/clients/shopify.py

@@ -89,8 +89,9 @@ async def get_id_email(self, token: str) -> Tuple[str, Optional[str]]:
                 An error occurred while getting the id and email.
 
         Examples:
-            >>> user_id, user_email = await client.get_id_email("TOKEN")
-
+            ```py
+            user_id, user_email = await client.get_id_email("TOKEN")
+            ```
         """
         async with self.get_httpx_client() as client:
             response = await client.get(

httpx_oauth/oauth2.py

@@ -105,7 +105,9 @@ class OAuth2Token(Dict[str, Any]):
     you can get access token like this:
 
     Examples:
-        >>> access_token = token["access_token"]
+        ```py
+        access_token = token["access_token"]
+        ```
     """
 
     def __init__(self, token_dict: Dict[str, Any]):
@@ -239,9 +241,11 @@ async def get_authorization_url(
             The authorization URL.
 
         Examples:
-            >>> authorization_url = await client.get_authorization_url(
+            ```py
+            authorization_url = await client.get_authorization_url(
                 "https://www.tintagel.bt/oauth-callback", scope=["SCOPE1", "SCOPE2", "SCOPE3"],
             )
+            ```py
         """
         params = {
             "response_type": "code",
@@ -288,7 +292,9 @@ async def get_access_token(
             GetAccessTokenError: An error occurred while getting the access token.
 
         Examples:
-            >>> access_token = await client.get_access_token("CODE", "https://www.tintagel.bt/oauth-callback")
+            ```py
+            access_token = await client.get_access_token("CODE", "https://www.tintagel.bt/oauth-callback")
+            ```
         """
         async with self.get_httpx_client() as client:
             data = {
@@ -328,7 +334,9 @@ async def refresh_token(self, refresh_token: str) -> OAuth2Token:
             RefreshTokenNotSupportedError: The provider does not support token refresh.
 
         Examples:
-            >>> access_token = await client.refresh_token("REFRESH_TOKEN")
+            ```py
+            access_token = await client.refresh_token("REFRESH_TOKEN")
+            ```
         """
         if self.refresh_token_endpoint is None:
             raise RefreshTokenNotSupportedError()
@@ -408,7 +416,9 @@ async def get_id_email(self, token: str) -> Tuple[str, Optional[str]]:
                 An error occurred while getting the id and email.
 
         Examples:
-            >>> user_id, user_email = await client.get_id_email("TOKEN")
+            ```py
+            user_id, user_email = await client.get_id_email("TOKEN")
+            ```
         """
         raise NotImplementedError()
 
@@ -479,7 +489,23 @@ def get_json(
 
 
 OAuth2 = BaseOAuth2[Dict[str, Any]]
-"""Generic OAuth2 client."""
+"""
+Generic OAuth2 client.
+
+Examples:
+    ```py
+    from httpx_oauth.oauth2 import OAuth2
+
+    client = OAuth2(
+        "CLIENT_ID",
+        "CLIENT_SECRET",
+        "AUTHORIZE_ENDPOINT",
+        "ACCESS_TOKEN_ENDPOINT",
+        refresh_token_endpoint="REFRESH_TOKEN_ENDPOINT",
+        revoke_token_endpoint="REVOKE_TOKEN_ENDPOINT",
+    )
+    ```
+"""
 
 __all__ = [
     "BaseOAuth2",

mkdocs.yml

@@ -29,6 +29,8 @@ theme:
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
+  features:
+      - content.code.copy
 
 extra_css:
   - assets/stylesheets/extra.css