mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-21 02:16:09 -05:00
[V3 Docs] Docs for utils package (#1085)
* Docstrings for chat formatting * Docstrings for mod utils * Type checking * Override CSS to highlight object name in definition * More typing * Utils docs pages * Fix typo here
This commit is contained in:
11
docs/_static/theme_overrides.css
vendored
Normal file
11
docs/_static/theme_overrides.css
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
|
||||
/*
|
||||
* This overrides the style for the path to each object definition, whilst
|
||||
* the name of the object remains unchanged.
|
||||
*
|
||||
* e.g. in the definition `redbot.core.Config`, `redbot.core` is the
|
||||
* desclassname.
|
||||
*/
|
||||
code.descclassname {
|
||||
font-weight: normal !important;
|
||||
}
|
||||
@@ -103,6 +103,9 @@ html_theme = 'sphinx_rtd_theme'
|
||||
# html_theme_options = {}
|
||||
|
||||
html_context = {
|
||||
'css_files': [
|
||||
'_static/theme_overrides.css'
|
||||
],
|
||||
# Enable the "Edit in GitHub link within the header of each page.
|
||||
'display_github': True,
|
||||
'github_user': 'Cog-Creators',
|
||||
|
||||
17
docs/framework_utils.rst
Normal file
17
docs/framework_utils.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. red's core utils documentation
|
||||
|
||||
=================
|
||||
Utility Functions
|
||||
=================
|
||||
|
||||
Chat Formatting
|
||||
===============
|
||||
|
||||
.. automodule:: redbot.core.utils.chat_formatting
|
||||
:members:
|
||||
|
||||
Mod Helpers
|
||||
===========
|
||||
|
||||
.. automodule:: redbot.core.utils.mod
|
||||
:members:
|
||||
@@ -37,6 +37,7 @@ Welcome to Red - Discord Bot's documentation!
|
||||
framework_i18n
|
||||
framework_modlog
|
||||
framework_context
|
||||
framework_utils
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user