doc: documentation overhaul

Author: null8626

README.md

@@ -2,6 +2,23 @@
 
 The community-maintained Python library for Top.gg.
 
+## Chapters
+
+- [Installation](#installation)
+- [Setting up](#setting-up)
+- [Usage](#usage)
+  - [Getting a bot](#getting-a-bot)
+  - [Getting several bots](#getting-several-bots)
+  - [Getting your bot's voters](#getting-your-bots-voters)
+  - [Check if a user has voted for your bot](#check-if-a-user-has-voted-for-your-bot)
+  - [Getting your bot's server count](#getting-your-bots-server-count)
+  - [Posting your bot's server count](#posting-your-bots-server-count)
+  - [Automatically posting your bot's server count every few minutes](#automatically-posting-your-bots-server-count-every-few-minutes)
+  - [Checking if the weekend vote multiplier is active](#checking-if-the-weekend-vote-multiplier-is-active)
+  - [Generating widget URLs](#generating-widget-urls)
+  - [Webhooks](#webhooks)
+    - [Being notified whenever someone voted for your bot](#being-notified-whenever-someone-voted-for-your-bot)
+
 ## Installation
 
 ```sh
@@ -10,24 +27,26 @@ $ pip install topggpy
 
 ## Setting up
 
-### Automatic cleanup
+### Implicit cleanup
 
 ```py
 import topgg
 
 import os
 
+
 async with topgg.Client(os.getenv('TOPGG_TOKEN')) as client:
   # ...
 ```
 
-### Manual cleanup
+### Explicit cleanup
 
 ```py
 import topgg
 
 import os
 
+
 client = topgg.Client(os.getenv('TOPGG_TOKEN'))
 
 # ...
@@ -165,6 +184,7 @@ import topgg
 import asyncio
 import os
 
+
 webhooks = topgg.Webhooks(os.getenv('MY_TOPGG_WEBHOOK_SECRET'), 8080)
 
 @webhooks.on_vote('/votes')

docs/_static/style.css

@@ -27,12 +27,30 @@ aside.toc-drawer .docutils:hover, .sidebar-brand-text:hover {
   filter: opacity(75%);
 }
 
-.highlight .c1, em {
+.highlight *, em {
   font-style: normal !important;
+  text-decoration: none !important;
+  font-weight: normal !important;
 }
 
-.highlight .nn {
-  text-decoration: none !important;
+.sig-paren, span.p, :not(.sig-name) > span.pre {
+  font-weight: normal !important;
+}
+
+:not(h1) > a.reference {
+  text-decoration: underline;
+}
+
+:not(h1) > a.reference:hover {
+  text-decoration: none;
+}
+
+.field-even p strong, .field-odd p strong {
+  font-family: var(--font-stack--monospace);
+}
+
+h1 > a.reference:hover {
+  text-decoration: underline;
 }
 
 h1 {
@@ -41,8 +59,4 @@ h1 {
 
 .sidebar-brand-text {
   font-weight: bolder;
-}
-
-.sidebar-scroll .reference.internal {
-  color: var(--color-brand-primary);
 }

docs/client.rst

@@ -4,11 +4,14 @@ Client reference
 .. autoclass:: topgg.client.Client
    :members:
 
-.. automodule:: topgg.widget
+.. autoclass:: topgg.widget.WidgetType()
    :members:
+   :undoc-members:
 
-.. autoclass:: topgg.models.SortBy()
-   :members:
+.. autofunction:: topgg.widget.large
+.. autofunction:: topgg.widget.owner
+.. autofunction:: topgg.widget.social
+.. autofunction:: topgg.widget.votes
 
 .. autoclass:: topgg.errors.Error()