updated doc theme

Author: kvsxxx

discord_ui/client.py

@@ -283,6 +283,7 @@ async def sync_commands(self, delete_unused=False):
         ----------
             delete_unused: :class:`bool`, optional
                 Whether the unused command should be deleted from the api; default ``False``
+        
         Raises
         ------
             :raises: :class:`InvalidArgument` : A slash command has an invalid guild_id
@@ -442,6 +443,7 @@ async def create_command(self, command):
         ----------
             command: :class:`SlashCommand` | :class:`ContextCommand`
                 The command that should be added
+        
         Raises
         ------
             :raises: :class:`InvalidArgument` : When a guild-id in ``guild_ids`` is not a valid server where the bot client is in it
@@ -577,6 +579,7 @@ async def edit_command(self, old_name, typ: Literal["slash", 1, "user", 2, "mess
                 The new guild permissions for the command
             callback: :class:`function`, optional, optional
                 The new command callback; default ``MISSING``
+        
         Raises
         ------
             :raises: :class:`NotFound` : When a command in the internal cache doesn't exsist
@@ -710,6 +713,7 @@ def add_command(self, name, callback=None, description=MISSING, options=[], guil
 
         name: :class:`str`
             1-32 characters long name
+
             .. note::
 
                 The name will be corrected automaticaly (spaces will be replaced with "-" and the name will be lowercased)
@@ -749,6 +753,7 @@ def command(self, name=MISSING, description=MISSING, options=[], guild_ids=MISSI
         ----------
             name: :class:`str`, optional
                 1-32 characters long name; default MISSING
+                
                 .. note::
 
                     The name will be corrected automaticaly (spaces will be replaced with "-" and the name will be lowercased)
@@ -829,6 +834,7 @@ def subcommand(self, base_names, name=MISSING, description=MISSING, options=[],
                     If you want to make a subcommand (``/base name``), you have to use a str instead of a list
             name: :class:`str`, optional
                 1-32 characters long name; default MISSING
+                
                 .. note::
 
                     The name will be corrected automaticaly (spaces will be replaced with "-" and the name will be lowercased)
@@ -990,6 +996,7 @@ def message_command(self, name=MISSING, guild_ids=MISSING, default_permission=Tr
                         The used slash command
                     message: :class:`~Message`
                         The message on which the command was used
+              
                     .. note::
 
                         ``ctx`` and ``message`` are just example names, you can use whatever you want for that
@@ -1255,6 +1262,7 @@ def send_webhook(self, webhook, content=MISSING, *, wait=False, username=MISSING
                 allowed mentions for the message; default None
             components: List[:class:`~Button` | :class:`~LinkButton` | :class:`~SelectMenu`], optional
                 the message components to include with the message; default None
+        
         Returns
         -------
             :returns: The message sent, if wait was True, else nothing will be returned

discord_ui/cogs.py

@@ -307,6 +307,7 @@ def slash_cog(name=MISSING, description=MISSING, options=[], guild_ids=MISSING,
     ----------
         name: :class:`str`, optional
             1-32 characters long name; default MISSING
+
             .. note::
 
                 The name will be corrected automaticaly (spaces will be replaced with "-" and the name will be lowercased)
@@ -371,6 +372,7 @@ def subslash_cog(base_names, name=MISSING, description=MISSING, options=[], guil
                 If you want to make a subcommand (``/base name``), you have to use a str instead of a list
         name: :class:`str`, optional
             1-32 characters long name; default MISSING
+            
             .. note::
 
                 The name will be corrected automaticaly (spaces will be replaced with "-" and the name will be lowercased)
@@ -463,6 +465,7 @@ def context_cog(type: Literal["user", 2, "message", 3], name=MISSING, guild_ids=
                         The used slash command
                     message: :class:`~Message`
                         The message on which the command was used
+                    
                     .. note::
 
                         ``ctx`` and ``message`` are just example names, you can use whatever you want for that

discord_ui/components.py

@@ -789,6 +789,7 @@ def filter(self, check = lambda x: ...):
         ----------
             check: :class:`lambda`
                 What condition has to be True that the component will pass the filter
+        
         Returns
         -------
             :returns: The filtered components

discord_ui/receive.py

@@ -639,6 +639,7 @@ async def edit(self, **fields):
         r = BetterRoute("PATCH", f"/webhooks/{self._application_id}/{self._interaction_token}/messages/{self.id}")
         self._update(await self._state.http.request(r, json=jsonifyMessage(**fields)))        
     async def delete(self):
+        """Override for delete function that will throw an exception"""
         raise EphemeralDeletion()
 
 class EphemeralResponseMessage(Message):
@@ -674,6 +675,7 @@ async def testing(ctx):
         route = BetterRoute("PATCH", f"/webhooks/{self.interaction.application_id}/{token}/messages/{self.id}")
         self._update(await self._state.http.request(route, json=jsonifyMessage(**fields)))
     async def delete(self):
+        """Override for delete function that will throw an exception"""
         raise EphemeralDeletion()
     async def disable_components(self, token, disable = True):
         """Disables all component in the message

discord_ui/slash/tools.py

@@ -194,6 +194,7 @@ def create_choice(name, value) -> dict:
             The name of the choice
         value: :class:`Any`
             The value that will be received when the user selected this choice
+    
     Returns
     -------
         :returns: The created choice

discord_ui/slash/types.py

@@ -351,6 +351,7 @@ class SlashCommand():
             name: :class:`str`
                 1-32 characters long name
                     If name is not passed, the name of the callback function will be used; default MISSING
+                    
                 .. important::
 
                     The name will be corrected automaticaly (spaces will be replaced with "-" and the name will be lowercased)

discord_ui/tools.py

@@ -107,6 +107,7 @@ def components_to_dict(*components) -> List[dict]:
     Raises
     ------
         :raises: :class:`Exception` : Invalid Data was passed
+    
     Returns
     -------
         :returns: The converted data

docs/source/_static/css/main.css

@@ -0,0 +1,75 @@
+.wy-nav-content, .wy-nav-content-wrap {
+    /* background-color: #23272A; */
+    /* color: white; */
+}
+
+.btn.btn-neutral {
+    border: 1px solid #2C2F33;
+    border-radius: 5px;
+    color: white
+}
+
+.admonition-title {
+    border-top: 1px solid white;
+    border-radius: 5px;
+}
+
+.admonition {
+    border: 1px solid white;
+    border-radius: 10px;
+    color: black;
+}
+
+code.docutils.literal.notranslate, .highlight, div.highlight-default.notranslate {
+    background-color: #2C2F33;
+    border: 2px solid #2C2F33;
+    border-radius: 5px;
+    line-height: 1em;
+    font-weight: 80;
+    color: white;
+}
+
+.wy-nav-side {
+    background-color: #23272A;
+}
+.wy-side-nav-search {
+    background-color: #5865F2;
+    border: 4px solid #5865F2;
+    border-bottom-left-radius: 6px;
+    border-bottom-right-radius: 6px;
+}
+
+.toctree-l1.current {
+    /* border: 0.5px solid white; */
+    border-radius: 2.5px;
+}
+
+dt::before {
+    content: " "
+}
+
+/* #region Scrollbar */
+/* Breite */
+::-webkit-scrollbar {
+    width: 8px;
+    height: 6px;
+}
+  
+/* Hintergrund von dem außer dem Scrollding */
+::-webkit-scrollbar-track {
+    background: #1b1b1b ;
+    border: 1px solid #1b1b1b;
+    /* border-radius: 15px; */
+}
+   
+/* Farbe von dem Scrollding */
+::-webkit-scrollbar-thumb {
+    background: #5865F2;
+    border: 1px solid #5865F2;
+    border-radius: 15px;
+}
+    
+/* Hover Farbe */
+::-webkit-scrollbar-thumb:hover {
+    background: #5865F2;
+}

docs/source/_static/js/override_colors.js

@@ -0,0 +1,56 @@
+function change_color(class_name, color) {
+    result = document.getElementsByClassName(class_name)
+    for (var i = 0; i < result.length; i++) {
+        result[i].style.color = color
+        result[i].style["font-weight"] = 100
+    };
+}
+
+window.onload = function() {
+    //#region colors
+    let string_green = "#afff7d"
+    let self_red = "#ff525d"
+    let int_orange = "#ffed85"
+
+    // numbers
+    change_color("mi", int_orange)
+    // '' string
+    change_color("s1", string_green)
+    // "" string
+    change_color("s2", string_green)
+    // """""" docstring
+    change_color("sd", string_green)
+    // bools
+    change_color("kc", self_red)
+
+    // import statements
+    change_color("kn", "#d962fc")
+    // import package
+    change_color("nn", "orange")
+    // comments
+    change_color("c1", "grey")
+
+    
+    // class name
+    change_color("nc", "orange")
+    // __init__
+    change_color("fm", "#5865F2")
+    // self
+    change_color("bp", self_red)
+
+    // async, def, await 
+    change_color("k", "#eb52ff")
+    // function name
+    change_color("nf", "#5865F2")
+    
+    // built-in function calls
+    change_color("nb", "#ecfc5b")
+    // +, -, *, /, =
+    change_color("o", "#69f5f2")
+    //#endregion
+
+    // fix code
+    result = document.getElementsByTagName("code");
+    for (let i = 0; i < result.length; i++)
+        result[i].style["font-weight"] = 100
+}

docs/source/cogs.rst

@@ -13,10 +13,10 @@ To use cog tools, you have to import the module
 
     from discord_ui.cogs import slash_cog, subslash_cog, context_cog, listening_component_cog
 
-    .. important::
+.. important::
 
-        You need a :class:`~Slash` instance for slashcommands cogs and a :class:`~Component` instance for listening components. 
-        The best would be to initialze a `~UI` instance, because it will initialize a component instance and a slash instance
+    You need a :class:`~Slash` instance for slashcommands cogs and a :class:`~Component` instance for listening components. 
+    The best would be to initialze a :class:`~UI` instance, because it will initialize a component instance and a slash instance
 
 
 Example