From d6aa3975916f95aeac00b28e874328a813d0d85b Mon Sep 17 00:00:00 2001 From: AstreaTSS <25420078+AstreaTSS@users.noreply.github.com> Date: Wed, 29 Nov 2023 15:25:58 -0500 Subject: [PATCH] docs: slightly improve search experience --- .../API Reference/API Reference/ext/hybrid_commands/index.md | 5 +++++ docs/src/API Reference/API Reference/ext/index.md | 5 +++++ .../API Reference/ext/prefixed_commands/index.md | 5 +++++ docs/src/API Reference/API Reference/models/Discord/index.md | 5 +++++ .../src/API Reference/API Reference/models/Internal/index.md | 5 +++++ docs/src/API Reference/API Reference/models/Misc/index.md | 5 +++++ docs/src/API Reference/API Reference/models/index.md | 5 +++++ docs/src/Guides/01 Getting Started.md | 5 +++++ docs/src/Guides/02 Creating Your Bot.md | 5 +++++ docs/src/Guides/03 Creating Commands.md | 5 +++++ docs/src/Guides/04 Context Menus.md | 5 +++++ docs/src/Guides/05 Components.md | 5 +++++ docs/src/Guides/06 Modals.md | 5 +++++ docs/src/Guides/08 Converters.md | 5 +++++ docs/src/Guides/10 Events.md | 5 +++++ docs/src/Guides/20 Extensions.md | 5 +++++ docs/src/Guides/22 Live Patching.md | 5 +++++ docs/src/Guides/23 Voice.md | 5 +++++ docs/src/Guides/24 Localisation.md | 5 +++++ docs/src/Guides/25 Error Tracking.md | 5 +++++ docs/src/Guides/26 Prefixed Commands.md | 5 +++++ docs/src/Guides/30 Pagination.md | 5 +++++ docs/src/Guides/40 Tasks.md | 5 +++++ docs/src/Guides/80 Sharding.md | 5 +++++ docs/src/Guides/90 Example.md | 5 +++++ docs/src/Guides/97 Migration From D.py.md | 5 +++++ docs/src/Guides/98 Migration from 4.X.md | 5 +++++ docs/src/Guides/99 2.x Migration_NAFF.md | 5 +++++ docs/src/Guides/index.md | 5 +++++ docs/src/index.md | 2 ++ 30 files changed, 147 insertions(+) diff --git a/docs/src/API Reference/API Reference/ext/hybrid_commands/index.md b/docs/src/API Reference/API Reference/ext/hybrid_commands/index.md index c2721707d..54b0d1cb4 100644 --- a/docs/src/API Reference/API Reference/ext/hybrid_commands/index.md +++ b/docs/src/API Reference/API Reference/ext/hybrid_commands/index.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Hybrid Commands Index - [Context](context) diff --git a/docs/src/API Reference/API Reference/ext/index.md b/docs/src/API Reference/API Reference/ext/index.md index 9e0753164..c59e1d35b 100644 --- a/docs/src/API Reference/API Reference/ext/index.md +++ b/docs/src/API Reference/API Reference/ext/index.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Ext Index These files contain useful features that help you develop a bot diff --git a/docs/src/API Reference/API Reference/ext/prefixed_commands/index.md b/docs/src/API Reference/API Reference/ext/prefixed_commands/index.md index 7c2f70db7..3f56f32df 100644 --- a/docs/src/API Reference/API Reference/ext/prefixed_commands/index.md +++ b/docs/src/API Reference/API Reference/ext/prefixed_commands/index.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Prefixed Commands Index - [Command](command) diff --git a/docs/src/API Reference/API Reference/models/Discord/index.md b/docs/src/API Reference/API Reference/models/Discord/index.md index a0281bbb7..d56908be7 100644 --- a/docs/src/API Reference/API Reference/models/Discord/index.md +++ b/docs/src/API Reference/API Reference/models/Discord/index.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Discord Models Index - [Activity](activity) diff --git a/docs/src/API Reference/API Reference/models/Internal/index.md b/docs/src/API Reference/API Reference/models/Internal/index.md index 05870d026..464717957 100644 --- a/docs/src/API Reference/API Reference/models/Internal/index.md +++ b/docs/src/API Reference/API Reference/models/Internal/index.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Internal Models Index - [Active Voice State](active_voice_state) diff --git a/docs/src/API Reference/API Reference/models/Misc/index.md b/docs/src/API Reference/API Reference/models/Misc/index.md index e58937c7e..15822e153 100644 --- a/docs/src/API Reference/API Reference/models/Misc/index.md +++ b/docs/src/API Reference/API Reference/models/Misc/index.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Misc Models Index - [Iterator](iterator) diff --git a/docs/src/API Reference/API Reference/models/index.md b/docs/src/API Reference/API Reference/models/index.md index 60181e494..d1eda2bc2 100644 --- a/docs/src/API Reference/API Reference/models/index.md +++ b/docs/src/API Reference/API Reference/models/index.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Models Within these pages, you will find a list of all available models within interactions.py. diff --git a/docs/src/Guides/01 Getting Started.md b/docs/src/Guides/01 Getting Started.md index ca59cc573..bda0b6058 100644 --- a/docs/src/Guides/01 Getting Started.md +++ b/docs/src/Guides/01 Getting Started.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Introduction Ready to get your Python on and create a Discord bot? This guide's got you covered with installation options and a basic bot code example. diff --git a/docs/src/Guides/02 Creating Your Bot.md b/docs/src/Guides/02 Creating Your Bot.md index e3d73e956..32f5265aa 100644 --- a/docs/src/Guides/02 Creating Your Bot.md +++ b/docs/src/Guides/02 Creating Your Bot.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Creating Your Bot To make a bot on Discord, you must first create an application on Discord. Thankfully, Discord has made this process very simple: diff --git a/docs/src/Guides/03 Creating Commands.md b/docs/src/Guides/03 Creating Commands.md index aa4f46c60..68856979c 100644 --- a/docs/src/Guides/03 Creating Commands.md +++ b/docs/src/Guides/03 Creating Commands.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Slash Commands So you want to make a slash command (or interaction, as they are officially called), but don't know how to get started? diff --git a/docs/src/Guides/04 Context Menus.md b/docs/src/Guides/04 Context Menus.md index 7d9aa63f7..4f24864c4 100644 --- a/docs/src/Guides/04 Context Menus.md +++ b/docs/src/Guides/04 Context Menus.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Context Menus Context menus are interactions under the hood. Defining them is very similar. diff --git a/docs/src/Guides/05 Components.md b/docs/src/Guides/05 Components.md index 763d170f1..4c56240ee 100644 --- a/docs/src/Guides/05 Components.md +++ b/docs/src/Guides/05 Components.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Components Components (Buttons, Select Menus and soon Text Input Fields) can be added to any message by passing them to the `components` argument in any `.send()` method. diff --git a/docs/src/Guides/06 Modals.md b/docs/src/Guides/06 Modals.md index 2960bdf8f..29f870a99 100644 --- a/docs/src/Guides/06 Modals.md +++ b/docs/src/Guides/06 Modals.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Modals Modals are basically popups which a user can use to send text information to your bot. As of the writing of this guide, you can use two components in a modal: diff --git a/docs/src/Guides/08 Converters.md b/docs/src/Guides/08 Converters.md index 56c3e873d..fa58c019b 100644 --- a/docs/src/Guides/08 Converters.md +++ b/docs/src/Guides/08 Converters.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Converters If your bot is complex enough, you might find yourself wanting to use custom models in your commands. Converters are classes that allow you to do just that, and can be used in both slash and prefixed commands. diff --git a/docs/src/Guides/10 Events.md b/docs/src/Guides/10 Events.md index 1253eee59..931403398 100644 --- a/docs/src/Guides/10 Events.md +++ b/docs/src/Guides/10 Events.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Events Events (in interactions.py) are pieces of information that are sent whenever something happens in Discord or in the library itself - this includes channel updates, message sending, the bot starting up, and more. diff --git a/docs/src/Guides/20 Extensions.md b/docs/src/Guides/20 Extensions.md index c782f72d7..3e2489107 100644 --- a/docs/src/Guides/20 Extensions.md +++ b/docs/src/Guides/20 Extensions.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Extensions ## Introduction diff --git a/docs/src/Guides/22 Live Patching.md b/docs/src/Guides/22 Live Patching.md index 4644c314f..13604c8f8 100644 --- a/docs/src/Guides/22 Live Patching.md +++ b/docs/src/Guides/22 Live Patching.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Live Patching interactions.py has a few built-in extensions that add some features, primarily for debugging. One of these extensions that you can enable separately is to add [`jurigged`](https://github.com/breuleux/jurigged) for live patching of code. diff --git a/docs/src/Guides/23 Voice.md b/docs/src/Guides/23 Voice.md index aa3c708d0..9be431860 100644 --- a/docs/src/Guides/23 Voice.md +++ b/docs/src/Guides/23 Voice.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Voice Support So you want to start playing some 🎵tunes🎶 in voice channels? Well let's get that going for you. diff --git a/docs/src/Guides/24 Localisation.md b/docs/src/Guides/24 Localisation.md index 43dfa1cc0..f29d8317a 100644 --- a/docs/src/Guides/24 Localisation.md +++ b/docs/src/Guides/24 Localisation.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Localising So your bot has grown, and now you need to ~~localize~~ localise your bot. Well thank god we support localisation then, huh? diff --git a/docs/src/Guides/25 Error Tracking.md b/docs/src/Guides/25 Error Tracking.md index 14b7ffca2..5a348c6e0 100644 --- a/docs/src/Guides/25 Error Tracking.md +++ b/docs/src/Guides/25 Error Tracking.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Error Tracking So, you've finally got your bot running on a server somewhere. Chances are, you're not checking the console output 24/7, looking for exceptions. diff --git a/docs/src/Guides/26 Prefixed Commands.md b/docs/src/Guides/26 Prefixed Commands.md index e58d24b15..d1c2a4d99 100644 --- a/docs/src/Guides/26 Prefixed Commands.md +++ b/docs/src/Guides/26 Prefixed Commands.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Creating Prefixed Commands Prefixed commands, called by Discord as "text commands" and sometimes called "message commands" (not to be confused with Context Menu Message Commands), are commands that are triggered when a user sends a normal message with a designated "prefix" in front of them. diff --git a/docs/src/Guides/30 Pagination.md b/docs/src/Guides/30 Pagination.md index 21ed4c5a3..c0e1101a5 100644 --- a/docs/src/Guides/30 Pagination.md +++ b/docs/src/Guides/30 Pagination.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Pagination > Pagination, also known as paging, is the process of dividing a document into discrete pages, either electronic pages or printed pages. diff --git a/docs/src/Guides/40 Tasks.md b/docs/src/Guides/40 Tasks.md index f7efeb912..6310d4e24 100644 --- a/docs/src/Guides/40 Tasks.md +++ b/docs/src/Guides/40 Tasks.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Tasks Tasks are background processes that can be used to asynchronously run code with a specified trigger. diff --git a/docs/src/Guides/80 Sharding.md b/docs/src/Guides/80 Sharding.md index 0fafb64d9..9fb636f66 100644 --- a/docs/src/Guides/80 Sharding.md +++ b/docs/src/Guides/80 Sharding.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Sharding Oh damn, your bot is getting pretty big, huh? Well I guess its time we discuss sharding. diff --git a/docs/src/Guides/90 Example.md b/docs/src/Guides/90 Example.md index 70690371f..0f1ab9dce 100644 --- a/docs/src/Guides/90 Example.md +++ b/docs/src/Guides/90 Example.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Examples ## `main.py` diff --git a/docs/src/Guides/97 Migration From D.py.md b/docs/src/Guides/97 Migration From D.py.md index c5d67fff6..e1b86576f 100644 --- a/docs/src/Guides/97 Migration From D.py.md +++ b/docs/src/Guides/97 Migration From D.py.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Migrating from discord.py 1. interactions.py requires python 3.10 (as compared to dpy's 3.5), you may need to upgrade python. diff --git a/docs/src/Guides/98 Migration from 4.X.md b/docs/src/Guides/98 Migration from 4.X.md index c37bf2804..398c8d152 100644 --- a/docs/src/Guides/98 Migration from 4.X.md +++ b/docs/src/Guides/98 Migration from 4.X.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Migrating from 4.X Version 5.X (and beyond) is a major rewrite of interactions.py compared to 4.X, though there have been major improvements to compensate for the change. 5.X was designed to be more stable and flexible, solving many of the bugs and UX issues 4.X had while also adding additional features you may like. diff --git a/docs/src/Guides/99 2.x Migration_NAFF.md b/docs/src/Guides/99 2.x Migration_NAFF.md index 9170a1156..d873d4c51 100644 --- a/docs/src/Guides/99 2.x Migration_NAFF.md +++ b/docs/src/Guides/99 2.x Migration_NAFF.md @@ -1,3 +1,8 @@ +--- +search: + boost: 3 +--- + # Migrating from NAFF Oh hey! So you're migrating from NAFF to interactions.py? Well lets get you sorted. diff --git a/docs/src/Guides/index.md b/docs/src/Guides/index.md index a02ced783..0209e6ebe 100644 --- a/docs/src/Guides/index.md +++ b/docs/src/Guides/index.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + Let's be honest; reading API documentation is a bit of a pain. These guides are meant to help you get started with the library and offer a point of reference. diff --git a/docs/src/index.md b/docs/src/index.md index cc1b5aeca..85dcc199c 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -3,6 +3,8 @@ hide: - navigation - toc - feedback +search: + exclude: true --- We hope this documentation is helpful for you, but don't just ++ctrl+c++ and ++ctrl+v++.